Class Api

Creates new Api instance.

Param

An object with the following keys:

Hierarchy

Index

Constructors

constructor

Properties

_httpOptions _uriGenerationMode serverAcceptsJSON Methods

Constructors

constructor

new Api(config): Api
Parameters
- config: IApiConfig
Returns Api
- Defined in Api.ts:71

Properties

_httpOptions

_httpOptions: IHttpOptions

_uriGenerationMode

_uriGenerationMode: boolean

serverAcceptsJSON

serverAcceptsJSON: boolean

`Static` Methods

Methods: {
    DELETE: string;
    GET: string;
    POST: string;
    PUT: string;
} = ...

Type declaration

DELETE: string
GET: string
POST: string
PUT: string

Methods

batch

batch(uriCollector, isAtomic?, isConcurrent?): Promise<any[]>
Performs batch call to the API.

Member Of
Api
Parameters
- uriCollector: ((batchApi) => string[])
  
  A function which will be invoked with api instance. This instance is special, as all methods there return a url string instead of making a backend call. uriCollector should return an array of uris to be executed in batch. So, for example, one may return [batchApi.metadata(), batchApi.count(...)] from uriCollector. That will mean call metadata() method and then call count() method.
  - - (batchApi): string[]
    - Parameters
      
      batchApi: IBatchApi
      
      Returns string[]
- Optional isAtomic: false
  
  Pass true if you want all operations to happen in the same transaction. There is a limitation, however. Atomic batch operations can only return success or error.
- Optional isConcurrent: boolean
  
  Requests to the DB are made asynchronously.
Returns Promise<any[]>
- Defined in Api.ts:501
batch(uriCollector, isAtomic?, isConcurrent?): Promise<void>
Parameters
- uriCollector: ((batchApi) => string[])
  - - (batchApi): string[]
    - Parameters
      
      batchApi: IBatchApi
      
      Returns string[]
- Optional isAtomic: true
- Optional isConcurrent: boolean
Returns Promise<void>
- Defined in Api.ts:506

clearApiKey

clearApiKey(): Promise<void>
Invalidates the current API key. Call this to be able to retrieve a new one using getApiKey().

Member Of
Api

Returns Promise<void>
A promise which will resolved if everything went ok and rejected otherwise
- Defined in Api.ts:188

copy

copy(objCode, objID, updates, fields?, options?): Promise<any>
Copies an existing object with making changes on a copy. Copying is supported only for some objects. The API Explorer page displays which objects support the Copy action.

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- objID: string
  
  ID of object to copy
- updates: object
  
  Which fields to set on copied object. See API Explorer for the list of available fields for the given objCode.
- Optional fields: TFields
  
  Which fields to return. See API Explorer for the list of available fields for the given objCode.
- Optional options: string[]
  
  A list of options that are attached to the copy request (object specific)
Returns Promise<any>
A promise which will resolved with results if everything went ok and rejected otherwise
- Defined in Api.ts:148

count

count(objCode, query?): Promise<number>
Used to retrieve number of objects matching given search criteria

Member Of
Api
Parameters
- objCode: string
- Optional query: object
  
  An object with search criteria
Returns Promise<number>
- Defined in Api.ts:172

create

create(objCode, params, fields?): Promise<any>
Creates a new object.

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- params: any
  
  Values of fields to be set for the new object. See API Explorer for the list of available fields for the given objCode.
- Optional fields: TFields
  
  Which fields of newly created object to return. See API Explorer for the list of available fields for the given objCode.
Returns Promise<any>
A promise which will resolved with the ID and any other specified fields of newly created object
- Defined in Api.ts:210

edit

edit(objCode, objID, updates, fields?): Promise<any>
Edits an existing object

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- objID: string
  
  ID of object to modify
- updates: any
  
  Which fields to set. See API Explorer for the list of available fields for the given objCode.
- Optional fields: TFields
  
  Which fields to return. See API Explorer for the list of available fields for the given objCode.
Returns Promise<any>
A promise which will resolved with results if everything went ok and rejected otherwise
- Defined in Api.ts:226

editMultiple

editMultiple(objCode, updates, fields?): Promise<any>
Edit multiple existing objects

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- updates: any[]
  
  Array of fields for each object to be edited. See API Explorer for the list of available fields for the given objCode.
- Optional fields: TFields
  
  Which fields to return. See API Explorer for the list of available fields for the given objCode.
Returns Promise<any>
A promise which will resolved with results if everything went ok and rejected otherwise
- Defined in Api.ts:241

execute

execute(objCode, objID, action, actionArgs?): Promise<any>
Executes an action for the given object

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- objID: string
  
  ID of object. Optional, pass null or undefined to omit
- action: string
  
  An action to execute. A list of allowed actions are available within the API Explorer under "actions" for each object.
- Optional actionArgs: object
  
  Optional. Arguments for the action. See API Explorer for the list of valid arguments
Returns Promise<any>
A promise which will resolved if everything went ok and rejected otherwise
- Defined in Api.ts:254

get

get(objCode, objIDs, fields?): Promise<any>
Used for retrieve an object or multiple objects.

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- objIDs: string | string[]
  
  Either one or multiple object ids
- Optional fields: TFields
  
  Which fields to return. See API Explorer for the list of available fields for the given objCode.
Returns Promise<any>
A promise which will resolved with results if everything went ok and rejected otherwise
- Defined in Api.ts:276

getApiKey

getApiKey(username, password, subdomain?): Promise<string>
Used to obtain an API key

Member Of
Api
Parameters
- username: string
  
  A username in Workfront
- password: string
  
  Password to use
- Optional subdomain: string
  
  Sub-domain to use
Returns Promise<string>
A promise which will resolved with API key if everything went ok and rejected otherwise
- Defined in Api.ts:108

`Protected` getHeaders

getHeaders(): Headers
Returns Headers
- Defined in Api.ts:585

login

login(username, password, subdomain?): Promise<any>
Logs in into Workfront. Should be a first call to Workfront API. Other calls should be made after this one will be completed.

Member Of
Api
Parameters
- username: string
  
  A username in Workfront
- password: string
  
  Password to use
- Optional subdomain: string
  
  Sub-domain to use
Returns Promise<any>
A promise which will resolved with logged in user data if everything went ok and rejected otherwise
- Defined in Api.ts:303

logout

logout(): Promise<void>
Logs out from Workfront

Member Of
Api

Returns Promise<void>
A promise which will resolved if everything went ok and rejected otherwise
- Defined in Api.ts:320

metadata

metadata(objCode?, fields?): Promise<any>
Retrieves API metadata for an object.

Member Of
Api
Parameters
- Optional objCode: string
  
  One of object codes from API Explorer. If omitted will return list of objects available in API.
- Optional fields: TFields
  
  Which fields to return.
Returns Promise<any>
A promise which will resolved with object metadata if everything went ok and rejected otherwise
- Defined in Api.ts:342

namedQuery

namedQuery(objCode, query, queryArgs?, fields?): Promise<any>
Executes a named query for the given obj code

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- query: string
  
  A query to execute. A list of allowed named queries are available within the API Explorer under "actions" for each object.
- Optional queryArgs: object
  
  Optional. Arguments for the action. See API Explorer for the list of valid arguments
- Optional fields: TFields
  
  Which fields to return. See API Explorer for the list of available fields for the given objCode.
Returns Promise<any>
A promise which will resolved with received data if everything went ok and rejected with error info otherwise
- Defined in Api.ts:359

remove

remove(objCode, objID, bForce?): Promise<void>
Deletes an object

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- objID: string
  
  ID of object
- Optional bForce: boolean
  
  Pass true to cause the server to remove the specified data and its dependants
Returns Promise<void>
A promise which will resolved if everything went ok and rejected otherwise
- Defined in Api.ts:371

report

report(objCode, query, useHttpPost?): Promise<any>
Performs report request, where only the aggregate of some field is desired, with one or more groupings.

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- query: object
  
  An object with search criteria and aggregate functions
- Optional useHttpPost: boolean = false
  
  Whenever to use POST to send query params
Returns Promise<any>
A promise which will resolved with results if everything went ok and rejected otherwise
- Defined in Api.ts:398

request

request(path, params, fields?, method?): Promise<any>
Do the request using Fetch API.

Member Of
Api
Parameters
- path: string
  
  URI path where the request calls
- params: any
  
  An object with params
- Optional fields: TFields = []
  
  Fields to query for the request
- Optional method: string = Api.Methods.GET
  
  The method which the request will do (GET|POST|PUT|DELETE)
Returns Promise<any>
A promise which will resolved with results if everything went ok and rejected otherwise
- Defined in Api.ts:419

search

search(objCode, query?, fields?, useHttpPost?): Promise<any>
Used for object retrieval by multiple search criteria.

Member Of
Api
Parameters
- objCode: string
  
  One of object codes from API Explorer
- Optional query: object
  
  An object with search criteria
- Optional fields: TFields
  
  Which fields to return. See API Explorer for the list of available fields for the given objCode.
- Optional useHttpPost: boolean = false
  
  Whenever to use POST to send query params
Returns Promise<any>
A promise which will resolved with search results if everything went ok and rejected otherwise
- Defined in Api.ts:472

setApiKey

setApiKey(apiKey): any
Sets a current API key for future requests

Member Of
Api
Parameters
- apiKey: any
Returns any
returns the given api key value
- Defined in Api.ts:549

setSessionID

setSessionID(sessionID): void
Sets a sessionID in the headers or removes sessionID if passed argument is undefined

Member Of
Api
Parameters
- sessionID: any
  
  sessionID to set
Returns void
- Defined in Api.ts:558

setXSRFToken

setXSRFToken(xsrfToken?): void
Sets a 'X-XSRF-TOKEN' in the headers or removes 'X-XSRF-TOKEN' if passed argument is undefined

Member Of
Api
Parameters
- Optional xsrfToken: string
  
  X-XSRF-TOKEN to set
Returns void
- Defined in Api.ts:571

uploadFileContent

uploadFileContent(fileContent, filename): Promise<any>
Parameters
- fileContent: any
- filename: string
Returns Promise<any>
- Defined in Api.ts:579

Class Api

Param

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: IApiConfig

Returns Api

Properties

_httpOptions

_uriGenerationMode

serverAcceptsJSON

Static Methods

Type declaration

DELETE: string

GET: string

POST: string

PUT: string

Methods

batch

Member Of

Parameters

uriCollector: ((batchApi) => string[])

Parameters

batchApi: IBatchApi

Returns string[]

Optional isAtomic: false

Optional isConcurrent: boolean

Returns Promise<any[]>

Parameters

uriCollector: ((batchApi) => string[])

Parameters

batchApi: IBatchApi

Returns string[]

Optional isAtomic: true

Optional isConcurrent: boolean

Returns Promise<void>

clearApiKey

Member Of

Returns Promise<void>

copy

Member Of

Parameters

objCode: string

objID: string

updates: object

Optional fields: TFields

Optional options: string[]

Returns Promise<any>

count

Member Of

Parameters

objCode: string

Optional query: object

Returns Promise<number>

create

Member Of

Parameters

objCode: string

params: any

Optional fields: TFields

Returns Promise<any>

edit

Member Of

Parameters

objCode: string

objID: string

updates: any

Optional fields: TFields

Returns Promise<any>

editMultiple

Member Of

Parameters

objCode: string

updates: any[]

Optional fields: TFields

`Static` Methods

`Optional` isAtomic: false

`Optional` isConcurrent: boolean

`Optional` isAtomic: true

`Optional` isConcurrent: boolean

`Optional` fields: TFields

`Optional` options: string[]

`Optional` query: object

`Optional` fields: TFields

`Optional` fields: TFields

`Optional` fields: TFields

`Optional` actionArgs: object

`Optional` fields: TFields

`Optional` subdomain: string

`Protected` getHeaders

`Optional` subdomain: string

`Optional` objCode: string

`Optional` fields: TFields

`Optional` queryArgs: object

`Optional` fields: TFields

`Optional` bForce: boolean

`Optional` useHttpPost: boolean = false

`Optional` fields: TFields = []

`Optional` method: string = Api.Methods.GET