Console
React Lib
REST API
Preparing search index...
The search index is not available
Integration App SDK - v1.9.0
Integration App SDK
DataSourceInstanceAccessor
Class DataSourceInstanceAccessor
Hierarchy (
view full
)
ElementInstanceAccessor
<
DataSourceInstance
,
DataSourceInstanceSelector
,
CreateDataSourceInstanceRequest
,
UpdateDataSourceInstanceRequest
>
DataSourceInstanceAccessor
Index
Constructors
constructor
Properties
options
client
Methods
get
Unique
Identifier
get
get
Id
create
put
patch
archive
delete
get
Path
setup
reset
open
Configuration
unified
Fields
To
Native
get
Collection
list
Records
match
Record
search
Records
find
Record
By
Id
create
Record
update
Record
delete
Record
find
Records
Constructors
constructor
new
Data
Source
Instance
Accessor
(
client
,
selector
)
:
DataSourceInstanceAccessor
Parameters
client
:
IntegrationAppApiClient
selector
:
string
|
DataSourceInstanceSelector
Returns
DataSourceInstanceAccessor
Properties
Protected
options
options
:
{
client
:
IntegrationAppApiClient
;
instancePath
:
string
;
selector
:
string
|
DataSourceInstanceSelector
;
type
?:
WorkspaceElementType
;
}
client
client
:
IntegrationAppApiClient
Methods
get
Unique
Identifier
get
Unique
Identifier
(
)
:
string
Returns
string
get
get
(
)
:
Promise
<
DataSourceInstance
>
Returns
Promise
<
DataSourceInstance
>
get
Id
get
Id
(
)
:
Promise
<
string
>
Returns
Promise
<
string
>
create
create
(
data
?
)
:
Promise
<
DataSourceInstance
>
Parameters
Optional
data
:
CreateDataSourceInstanceRequest
Returns
Promise
<
DataSourceInstance
>
put
put
(
data
)
:
Promise
<
DataSourceInstance
>
Parameters
data
:
CreateDataSourceInstanceRequest
Returns
Promise
<
DataSourceInstance
>
patch
patch
(
data
)
:
Promise
<
DataSourceInstance
>
Parameters
data
:
UpdateDataSourceInstanceRequest
Returns
Promise
<
DataSourceInstance
>
archive
archive
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
delete
delete
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Deprecated
use
archive
instead
Protected
get
Path
get
Path
(
operation
?
)
:
string
Parameters
operation
:
string
= ''
Returns
string
setup
setup
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
reset
reset
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
open
Configuration
open
Configuration
(
__namedParameters
?
)
:
Promise
<
void
>
Parameters
__namedParameters
:
OpenDataSourceConfigurationOptions
= {}
Returns
Promise
<
void
>
unified
Fields
To
Native
unified
Fields
To
Native
(
unifiedFields
)
:
Promise
<
any
>
Parameters
unifiedFields
:
any
Returns
Promise
<
any
>
get
Collection
get
Collection
(
)
:
Promise
<
DataCollectionSpec
>
Returns
Promise
<
DataCollectionSpec
>
list
Records
list
Records
(
request
?
)
:
Promise
<
DataCollectionListResponse
>
Parameters
request
:
DataCollectionListRequest
= {}
Returns
Promise
<
DataCollectionListResponse
>
match
Record
match
Record
(
request
)
:
Promise
<
DataCollectionMatchResponse
>
Parameters
request
:
DataCollectionMatchRequest
Returns
Promise
<
DataCollectionMatchResponse
>
search
Records
search
Records
(
request
)
:
Promise
<
DataCollectionSearchResponse
>
Parameters
request
:
DataCollectionSearchRequest
Returns
Promise
<
DataCollectionSearchResponse
>
find
Record
By
Id
find
Record
By
Id
(
request
)
:
Promise
<
DataCollectionFindByIdResponse
>
Parameters
request
:
string
|
DataCollectionFindByIdRequest
Returns
Promise
<
DataCollectionFindByIdResponse
>
create
Record
create
Record
(
request
)
:
Promise
<
DataCollectionCreateResponse
>
Parameters
request
:
DataCollectionCreateRequest
Returns
Promise
<
DataCollectionCreateResponse
>
update
Record
update
Record
(
request
)
:
Promise
<
DataCollectionUpdateResponse
>
Parameters
request
:
DataCollectionUpdateRequest
Returns
Promise
<
DataCollectionUpdateResponse
>
delete
Record
delete
Record
(
request
)
:
Promise
<
DataCollectionDeleteResponse
>
Parameters
request
:
string
|
DataCollectionFindByIdRequest
Returns
Promise
<
DataCollectionDeleteResponse
>
find
Records
find
Records
(
request
?
)
:
Promise
<
DataCollectionFindResponse
>
Parameters
request
:
DataCollectionFindRequest
= {}
Returns
Promise
<
DataCollectionFindResponse
>
Deprecated
use
listRecords
instead
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
options
client
Methods
get
Unique
Identifier
get
get
Id
create
put
patch
archive
delete
get
Path
setup
reset
open
Configuration
unified
Fields
To
Native
get
Collection
list
Records
match
Record
search
Records
find
Record
By
Id
create
Record
update
Record
delete
Record
find
Records
Console
React Lib
REST API
Integration App SDK - v1.9.0
Loading...
Deprecated
archive
instead