Search
Preparing search index...
The search index is not available
connectwise-rest-api
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"api/api"
DocumentsSetupApi
Class DocumentsSetupApi
Hierarchy
DocumentsSetupApi
Index
Constructors
constructor
Properties
base
Path
default
Headers
Methods
system
Mycompany
Documents
Get
system
Mycompany
Documents
IdGet
system
Mycompany
Documents
IdPatch
system
Mycompany
Documents
IdPut
Constructors
constructor
new
Documents
Setup
Api
(
basePath
?:
string
)
:
DocumentsSetupApi
Parameters
Optional
basePath:
string
Returns
DocumentsSetupApi
Properties
Protected
base
Path
base
Path
:
string
= "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"
default
Headers
default
Headers
:
any
Methods
system
Mycompany
Documents
Get
system
Mycompany
Documents
Get
(
params
:
object
, extraQueryParams
?:
any
, extraFetchParams
?:
any
)
:
Promise
<
Array
<
DocumentSetup
>
>
Get Documents
Parameters
params:
object
Optional
childconditions
?:
string
Optional
conditions
?:
string
Optional
customfieldconditions
?:
string
Optional
order
By
?:
string
Optional
page
?:
number
Optional
page
Size
?:
number
Optional
extraQueryParams:
any
Optional
extraFetchParams:
any
Returns
Promise
<
Array
<
DocumentSetup
>
>
system
Mycompany
Documents
IdGet
system
Mycompany
Documents
IdGet
(
params
:
object
, extraQueryParams
?:
any
, extraFetchParams
?:
any
)
:
Promise
<
DocumentSetup
>
Get Document By Id
Parameters
params:
object
id
:
number
Optional
extraQueryParams:
any
Optional
extraFetchParams:
any
Returns
Promise
<
DocumentSetup
>
system
Mycompany
Documents
IdPatch
system
Mycompany
Documents
IdPatch
(
params
:
object
, extraQueryParams
?:
any
, extraFetchParams
?:
any
)
:
Promise
<
DocumentSetup
>
Update Document
Parameters
params:
object
id
:
number
operations
:
Array
<
PatchOperation
>
Optional
extraQueryParams:
any
Optional
extraFetchParams:
any
Returns
Promise
<
DocumentSetup
>
system
Mycompany
Documents
IdPut
system
Mycompany
Documents
IdPut
(
params
:
object
, extraQueryParams
?:
any
, extraFetchParams
?:
any
)
:
Promise
<
DocumentSetup
>
Replace Document
Parameters
params:
object
document
:
DocumentSetup
id
:
number
Optional
extraQueryParams:
any
Optional
extraFetchParams:
any
Returns
Promise
<
DocumentSetup
>
Globals
"api/api"
"api/assign"
"connectwise"
Documents
Setup
Api
constructor
base
Path
default
Headers
system
Mycompany
Documents
Get
system
Mycompany
Documents
IdGet
system
Mycompany
Documents
IdPatch
system
Mycompany
Documents
IdPut
Generated using
TypeDoc
Get Documents