Search
Preparing search index...
The search index is not available
io.parrots
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"app/service/InstanceService.service"
InstanceService
Class InstanceService
Hierarchy
InstanceService
Index
Constructors
constructor
Properties
instance
Connection
Manager
SESSION_
ID_
KEY
Methods
active
Process
Definition
Version
add
Groups
ToUser
add
Trigger
add
Users
add
Users
ToGroup
adding
Header
Request
Options
Args
cerate
User
Config
create
Collection
create
Cron
create
Group
create
Group
Types
create
Job
create
Paper
Size
create
Preferences
create
Process
Definition
create
Schedule
create
Template
delete
Group
delete
Group
Types
delete
User
disable
Group
disable
Group
Type
disable
Schedule
disable
User
edit
Classes
Configure
edit
Collection
edit
Group
edit
Group
Types
edit
Groups
edit
Metadata
Classes
edit
Papper
Size
edit
Preferences
edit
Schedule
edit
System
Config
edit
User
Config
edit
User
Type
enable
Group
enable
Group
Type
enable
Schedule
enable
User
get
Authorize
Users
ByGroup
getBPMNMonitor
get
Classes
get
Count
Provider
get
Count
Template
get
Count
Version
get
Group
Types
get
Groups
get
Historic
Activity
Instance
get
Instance
Session
Id
get
List
Job
get
List
Schedule
get
Metadata
Classes
get
Paper
Size
get
Preferences
get
Process
Definition
Version
get
Process
Definitions
get
Provider
Custom
Template
get
Provider
Name
Template
get
Providers
get
Providers
Installed
get
Prtocess
Instance
get
Query
Classes
get
Search
Job
get
Search
Schedule
get
Selected
Classes
get
State
Ful
Classes
get
System
Config
get
Template
Byte
Data
get
Trigger
get
User
Config
get
Users
get
Version
get
Version
Custom
get
Version
Name
Template
interrupt
Job
login
With
Instance
Server
remove
Trigger
remove
Users
ToGroup
set
Instance
Session
Id
suspend
Process
Definition
Version
upload
File
Template
Constructors
constructor
new
Instance
Service
(
instanceConnectionManager
:
InstanceConnectionManager
)
:
InstanceService
Parameters
instanceConnectionManager:
InstanceConnectionManager
Returns
InstanceService
Properties
Private
instance
Connection
Manager
instance
Connection
Manager
:
InstanceConnectionManager
Static
SESSION_
ID_
KEY
SESSION_
ID_
KEY
:
string
= "Instance-Session-Id"
Methods
active
Process
Definition
Version
active
Process
Definition
Version
(
id
:
string
)
:
Promise
<
any
>
Parameters
id:
string
Returns
Promise
<
any
>
add
Groups
ToUser
add
Groups
ToUser
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
add
Trigger
add
Trigger
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
add
Users
add
Users
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
add
Users
ToGroup
add
Users
ToGroup
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
Private
adding
Header
Request
Options
Args
adding
Header
Request
Options
Args
(
options
:
RequestOptionsArgs
, headerData
:
object
, xmlType
?:
boolean
)
:
RequestOptionsArgs
Parameters
options:
RequestOptionsArgs
headerData:
object
[
name:
string
]:
string
Optional
xmlType:
boolean
Returns
RequestOptionsArgs
cerate
User
Config
cerate
User
Config
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Collection
create
Collection
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Cron
create
Cron
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
create
Group
create
Group
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Group
Types
create
Group
Types
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Job
create
Job
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Paper
Size
create
Paper
Size
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Preferences
create
Preferences
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Process
Definition
create
Process
Definition
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Schedule
create
Schedule
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
create
Template
create
Template
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
delete
Group
delete
Group
(
_uuid
:
string
)
:
Promise
<
any
>
Parameters
_uuid:
string
Returns
Promise
<
any
>
delete
Group
Types
delete
Group
Types
(
_uuid
:
string
)
:
Promise
<
any
>
Parameters
_uuid:
string
Returns
Promise
<
any
>
delete
User
delete
User
(
_uuid
:
string
)
:
Promise
<
any
>
Parameters
_uuid:
string
Returns
Promise
<
any
>
disable
Group
disable
Group
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
disable
Group
Type
disable
Group
Type
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
disable
Schedule
disable
Schedule
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
disable
User
disable
User
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
edit
Classes
Configure
edit
Classes
Configure
(
className
:
any
, body
:
any
)
:
Promise
<
any
>
Parameters
className:
any
body:
any
Returns
Promise
<
any
>
edit
Collection
edit
Collection
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
edit
Group
edit
Group
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
edit
Group
Types
edit
Group
Types
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
edit
Groups
edit
Groups
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
edit
Metadata
Classes
edit
Metadata
Classes
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
edit
Papper
Size
edit
Papper
Size
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
edit
Preferences
edit
Preferences
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
edit
Schedule
edit
Schedule
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
edit
System
Config
edit
System
Config
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
edit
User
Config
edit
User
Config
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
edit
User
Type
edit
User
Type
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
enable
Group
enable
Group
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
enable
Group
Type
enable
Group
Type
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
enable
Schedule
enable
Schedule
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
enable
User
enable
User
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
get
Authorize
Users
ByGroup
get
Authorize
Users
ByGroup
(
groupUUID
:
string
, permissionLevel
:
string
)
:
Promise
<
any
>
Parameters
groupUUID:
string
permissionLevel:
string
Returns
Promise
<
any
>
getBPMNMonitor
getBPMNMonitor
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
get
Classes
get
Classes
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Count
Provider
get
Count
Provider
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Count
Template
get
Count
Template
(
providerName
:
any
, versionName
:
any
)
:
Promise
<
any
>
Parameters
providerName:
any
versionName:
any
Returns
Promise
<
any
>
get
Count
Version
get
Count
Version
(
providerName
:
any
)
:
Promise
<
any
>
Parameters
providerName:
any
Returns
Promise
<
any
>
get
Group
Types
get
Group
Types
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Groups
get
Groups
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Historic
Activity
Instance
get
Historic
Activity
Instance
(
procDef_uuid
:
any
, procInst_uuid
:
any
, rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
procDef_uuid:
any
procInst_uuid:
any
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Instance
Session
Id
get
Instance
Session
Id
(
)
:
string
Returns
string
get
List
Job
get
List
Job
(
sortBy
:
string
, sortAcs
:
boolean
, rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
sortBy:
string
sortAcs:
boolean
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
List
Schedule
get
List
Schedule
(
sortBy
:
string
, sortAcs
:
boolean
, rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
sortBy:
string
sortAcs:
boolean
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Metadata
Classes
get
Metadata
Classes
(
classesName
:
string
)
:
Promise
<
any
>
Parameters
classesName:
string
Returns
Promise
<
any
>
get
Paper
Size
get
Paper
Size
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Preferences
get
Preferences
(
className
:
any
, sortBy
:
string
, sortAcs
:
boolean
, rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
className:
any
sortBy:
string
sortAcs:
boolean
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Process
Definition
Version
get
Process
Definition
Version
(
key
:
string
)
:
Promise
<
any
>
Parameters
key:
string
Returns
Promise
<
any
>
get
Process
Definitions
get
Process
Definitions
(
rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Provider
Custom
Template
get
Provider
Custom
Template
(
rangeStart
:
number
, rangeEnd
:
number
, uuid
:
string
)
:
Promise
<
any
>
Parameters
rangeStart:
number
rangeEnd:
number
uuid:
string
Returns
Promise
<
any
>
get
Provider
Name
Template
get
Provider
Name
Template
(
providerName
:
any
)
:
Promise
<
any
>
Parameters
providerName:
any
Returns
Promise
<
any
>
get
Providers
get
Providers
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Providers
Installed
get
Providers
Installed
(
rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Prtocess
Instance
get
Prtocess
Instance
(
uuid
:
any
, rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
uuid:
any
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Query
Classes
get
Query
Classes
(
body
:
any
, classesName
:
string
)
:
Promise
<
any
>
Parameters
body:
any
classesName:
string
Returns
Promise
<
any
>
get
Search
Job
get
Search
Job
(
search
:
string
, sortBy
:
string
, sortAcs
:
boolean
, rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
search:
string
sortBy:
string
sortAcs:
boolean
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Search
Schedule
get
Search
Schedule
(
search
:
string
, sortBy
:
string
, sortAcs
:
boolean
, rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
search:
string
sortBy:
string
sortAcs:
boolean
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Selected
Classes
get
Selected
Classes
(
classesName
:
string
, xmlType
:
boolean
)
:
Promise
<
any
>
Parameters
classesName:
string
xmlType:
boolean
Returns
Promise
<
any
>
get
State
Ful
Classes
get
State
Ful
Classes
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
System
Config
get
System
Config
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Template
Byte
Data
get
Template
Byte
Data
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
get
Trigger
get
Trigger
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
get
User
Config
get
User
Config
(
uuid
:
any
)
:
Promise
<
any
>
Parameters
uuid:
any
Returns
Promise
<
any
>
get
Users
get
Users
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
get
Version
get
Version
(
providerName
:
any
)
:
Promise
<
any
>
Parameters
providerName:
any
Returns
Promise
<
any
>
get
Version
Custom
get
Version
Custom
(
rangeStart
:
number
, rangeEnd
:
number
)
:
Promise
<
any
>
Parameters
rangeStart:
number
rangeEnd:
number
Returns
Promise
<
any
>
get
Version
Name
Template
get
Version
Name
Template
(
providerName
:
any
, versionName
:
any
)
:
Promise
<
any
>
Parameters
providerName:
any
versionName:
any
Returns
Promise
<
any
>
interrupt
Job
interrupt
Job
(
uuid
:
string
)
:
Promise
<
any
>
Parameters
uuid:
string
Returns
Promise
<
any
>
login
With
Instance
Server
login
With
Instance
Server
(
accountUUID
:
string
, client
?:
any
)
:
Promise
<
any
>
Parameters
accountUUID:
string
Optional
client:
any
Returns
Promise
<
any
>
remove
Trigger
remove
Trigger
(
_uuid
:
string
, uuidTrigger
:
string
)
:
Promise
<
any
>
Parameters
_uuid:
string
uuidTrigger:
string
Returns
Promise
<
any
>
remove
Users
ToGroup
remove
Users
ToGroup
(
body
:
any
, uuid
:
any
)
:
Promise
<
any
>
Parameters
body:
any
uuid:
any
Returns
Promise
<
any
>
set
Instance
Session
Id
set
Instance
Session
Id
(
sessionId
:
string
)
:
void
Parameters
sessionId:
string
Returns
void
suspend
Process
Definition
Version
suspend
Process
Definition
Version
(
id
:
string
)
:
Promise
<
any
>
Parameters
id:
string
Returns
Promise
<
any
>
upload
File
Template
upload
File
Template
(
body
:
any
)
:
Promise
<
any
>
Parameters
body:
any
Returns
Promise
<
any
>
Globals
"app/service/
Instance
Service.service"
Instance
Service
constructor
instance
Connection
Manager
SESSION_
ID_
KEY
active
Process
Definition
Version
add
Groups
ToUser
add
Trigger
add
Users
add
Users
ToGroup
adding
Header
Request
Options
Args
cerate
User
Config
create
Collection
create
Cron
create
Group
create
Group
Types
create
Job
create
Paper
Size
create
Preferences
create
Process
Definition
create
Schedule
create
Template
delete
Group
delete
Group
Types
delete
User
disable
Group
disable
Group
Type
disable
Schedule
disable
User
edit
Classes
Configure
edit
Collection
edit
Group
edit
Group
Types
edit
Groups
edit
Metadata
Classes
edit
Papper
Size
edit
Preferences
edit
Schedule
edit
System
Config
edit
User
Config
edit
User
Type
enable
Group
enable
Group
Type
enable
Schedule
enable
User
get
Authorize
Users
ByGroup
getBPMNMonitor
get
Classes
get
Count
Provider
get
Count
Template
get
Count
Version
get
Group
Types
get
Groups
get
Historic
Activity
Instance
get
Instance
Session
Id
get
List
Job
get
List
Schedule
get
Metadata
Classes
get
Paper
Size
get
Preferences
get
Process
Definition
Version
get
Process
Definitions
get
Provider
Custom
Template
get
Provider
Name
Template
get
Providers
get
Providers
Installed
get
Prtocess
Instance
get
Query
Classes
get
Search
Job
get
Search
Schedule
get
Selected
Classes
get
State
Ful
Classes
get
System
Config
get
Template
Byte
Data
get
Trigger
get
User
Config
get
Users
get
Version
get
Version
Custom
get
Version
Name
Template
interrupt
Job
login
With
Instance
Server
remove
Trigger
remove
Users
ToGroup
set
Instance
Session
Id
suspend
Process
Definition
Version
upload
File
Template
Generated using
TypeDoc