namespace static

nexus.process.annotation

Source: src/process/annotation/index.js:5

Methods

create(params)
remove(params)
update(params)

Methods

async static

create(params) → Promise containing ApiResponse

creates a process annotation

Parameters

Name Type Optional Description

params

Object

 

Values in params have the following properties:

Name Type Optional Description

processId

string

 

data

Object

 

data.text

string

 

data.userTimestamp

number

 
Returns

Promise containing ApiResponse 

async static

remove(params) → Promise containing ApiResponse

deletes a process annotation

Parameters

Name Type Optional Description

params

Object

 

Values in params have the following properties:

Name Type Optional Description

processId

string

 

annotationId

string

 
Returns

Promise containing ApiResponse 

async static

update(params) → Promise containing ApiResponse

updates a process annotation

Parameters

Name Type Optional Description

params

Object

 

Values in params have the following properties:

Name Type Optional Description

processId

string

 

annotationId

string

 

data

Object

 

data.text

string

 

data.userTimestamp

number

 
Returns

Promise containing ApiResponse