@servicenow/sdk - v4.7.0
Preparing search index...
@servicenow/sdk/api
<internal>
IConnector
Interface IConnector
interface
IConnector
{
appCreatorVendorPrefix
()
:
Promise
<
string
>
;
appUpgradeStatus
(
scope
:
string
)
:
Promise
<
{
finished
:
boolean
;
id
:
string
}
>
;
download
(
scope
:
string
,
options
?:
|
{
method
:
"complete"
}
|
{
lastPull
?:
string
;
method
:
"incremental"
}
,
)
:
Promise
<
Response
>
;
downloadUpdateSet
(
updateSetId
:
string
,
scopeId
:
string
)
:
Promise
<
Response
>
;
fetch
(
path
:
string
,
init
?:
RequestInit
,
params
?:
URLSearchParams
,
)
:
Promise
<
Response
>
;
getHost
()
:
URL
;
getInstanceBuildName
()
:
Promise
<
string
|
undefined
>
;
getProgress
(
progressId
:
string
,
)
:
Promise
<
{
percent_complete
:
number
;
status
:
string
;
status_message
:
string
}
,
>
;
getScopeInfo
(
scope
?:
string
,
scopeId
?:
string
,
)
:
Promise
<
|
{
active
:
boolean
;
appId
:
string
;
name
:
string
;
scope
:
string
;
shortDescription
:
string
;
sysClassName
:
string
;
}
|
undefined
,
>
;
getUpdateMutex
()
:
Promise
<
boolean
>
;
getUpdateXMLCount
(
updateSetId
:
string
)
:
Promise
<
number
>
;
moveToApp
(
sysIds
:
string
[]
,
scope
:
string
,
)
:
Promise
<
CustomizeOrMoveResult
[]
>
;
processorRequest
(
api
:
string
,
search
:
URLSearchParams
,
)
:
Promise
<
{
status
:
number
;
value
:
string
}
>
;
setCurrentApplication
(
scopeId
:
string
)
:
Promise
<
void
>
;
syntaxEditorCacheScriptIncludes
()
:
Promise
<
Record
<
string
,
string
>
>
;
syntaxEditorCompletionDefinitions
()
:
Promise
<
string
>
;
syntaxEditorDefinitionsScriptIncludes
(
scriptIncludeIds
:
string
[]
,
)
:
Promise
<
Record
<
string
,
string
>
>
;
uninstallApplication
(
scopeId
:
string
,
isStoreApp
:
boolean
,
)
:
Promise
<
Response
>
;
unloadDependentRecords
(
request
:
BatchUnloadRequest
,
)
:
Promise
<
UnloadedRecord
[]
>
;
unloadDependentRecords
<
T
extends
string
>
(
table
:
T
,
sysId
:
string
,
tableGraphs
:
RelationshipHierarchy
<
T
>
[]
,
scopeId
?:
string
,
)
:
Promise
<
UnloadedRecord
[]
>
;
unloadRecords
(
sysIds
:
string
[]
,
scopeId
:
string
)
:
Promise
<
UnloadedRecord
[]
>
;
uploadScopedAppPackage
(
file
:
Blob
,
options
:
{
appInfo
?:
{
scope
:
string
;
scopeId
:
string
;
version
:
string
}
;
installAsync
?:
boolean
;
isStoreApp
?:
boolean
;
loadDemoData
?:
boolean
;
registerScope
?:
boolean
;
timeoutMs
?:
number
;
}
,
)
:
Promise
<
{
rollbackId
:
string
;
trackerId
:
string
}
|
undefined
>
;
uploadXmlFiles
(
scope
:
string
,
files
:
{
blob
:
Blob
;
name
:
string
}
[]
,
options
?:
{
targetUpdateSetId
?:
string
;
timeoutMs
?:
number
}
,
)
:
Promise
<
string
>
;
}
Implemented by
Connector
Index
Methods
app
Creator
Vendor
Prefix
app
Upgrade
Status
download
download
Update
Set
fetch
get
Host
get
Instance
Build
Name
get
Progress
get
Scope
Info
get
Update
Mutex
get
Update
XML
Count
move
To
App
processor
Request
set
Current
Application
syntax
Editor
Cache
Script
Includes
syntax
Editor
Completion
Definitions
syntax
Editor
Definitions
Script
Includes
uninstall
Application
unload
Dependent
Records
unload
Records
upload
Scoped
App
Package
upload
Xml
Files
Methods
app
Creator
Vendor
Prefix
appCreatorVendorPrefix
()
:
Promise
<
string
>
Returns
Promise
<
string
>
app
Upgrade
Status
appUpgradeStatus
(
scope
:
string
)
:
Promise
<
{
finished
:
boolean
;
id
:
string
}
>
Parameters
scope
:
string
Returns
Promise
<
{
finished
:
boolean
;
id
:
string
}
>
download
download
(
scope
:
string
,
options
?:
|
{
method
:
"complete"
}
|
{
lastPull
?:
string
;
method
:
"incremental"
}
,
)
:
Promise
<
Response
>
Parameters
scope
:
string
Optional
options
:
{
method
:
"complete"
}
|
{
lastPull
?:
string
;
method
:
"incremental"
}
Returns
Promise
<
Response
>
download
Update
Set
downloadUpdateSet
(
updateSetId
:
string
,
scopeId
:
string
)
:
Promise
<
Response
>
Parameters
updateSetId
:
string
scopeId
:
string
Returns
Promise
<
Response
>
fetch
fetch
(
path
:
string
,
init
?:
RequestInit
,
params
?:
URLSearchParams
,
)
:
Promise
<
Response
>
Parameters
path
:
string
Optional
init
:
RequestInit
Optional
params
:
URLSearchParams
Returns
Promise
<
Response
>
get
Host
getHost
()
:
URL
Returns
URL
get
Instance
Build
Name
getInstanceBuildName
()
:
Promise
<
string
|
undefined
>
Returns
Promise
<
string
|
undefined
>
get
Progress
getProgress
(
progressId
:
string
,
)
:
Promise
<
{
percent_complete
:
number
;
status
:
string
;
status_message
:
string
}
,
>
Parameters
progressId
:
string
Returns
Promise
<
{
percent_complete
:
number
;
status
:
string
;
status_message
:
string
}
>
get
Scope
Info
getScopeInfo
(
scope
?:
string
,
scopeId
?:
string
,
)
:
Promise
<
|
{
active
:
boolean
;
appId
:
string
;
name
:
string
;
scope
:
string
;
shortDescription
:
string
;
sysClassName
:
string
;
}
|
undefined
,
>
Parameters
Optional
scope
:
string
Optional
scopeId
:
string
Returns
Promise
<
|
{
active
:
boolean
;
appId
:
string
;
name
:
string
;
scope
:
string
;
shortDescription
:
string
;
sysClassName
:
string
;
}
|
undefined
,
>
get
Update
Mutex
getUpdateMutex
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
get
Update
XML
Count
getUpdateXMLCount
(
updateSetId
:
string
)
:
Promise
<
number
>
Parameters
updateSetId
:
string
Returns
Promise
<
number
>
move
To
App
moveToApp
(
sysIds
:
string
[]
,
scope
:
string
)
:
Promise
<
CustomizeOrMoveResult
[]
>
Parameters
sysIds
:
string
[]
scope
:
string
Returns
Promise
<
CustomizeOrMoveResult
[]
>
processor
Request
processorRequest
(
api
:
string
,
search
:
URLSearchParams
,
)
:
Promise
<
{
status
:
number
;
value
:
string
}
>
Parameters
api
:
string
search
:
URLSearchParams
Returns
Promise
<
{
status
:
number
;
value
:
string
}
>
set
Current
Application
setCurrentApplication
(
scopeId
:
string
)
:
Promise
<
void
>
Parameters
scopeId
:
string
Returns
Promise
<
void
>
syntax
Editor
Cache
Script
Includes
syntaxEditorCacheScriptIncludes
()
:
Promise
<
Record
<
string
,
string
>
>
Returns
Promise
<
Record
<
string
,
string
>
>
syntax
Editor
Completion
Definitions
syntaxEditorCompletionDefinitions
()
:
Promise
<
string
>
Returns
Promise
<
string
>
syntax
Editor
Definitions
Script
Includes
syntaxEditorDefinitionsScriptIncludes
(
scriptIncludeIds
:
string
[]
,
)
:
Promise
<
Record
<
string
,
string
>
>
Parameters
scriptIncludeIds
:
string
[]
Returns
Promise
<
Record
<
string
,
string
>
>
uninstall
Application
uninstallApplication
(
scopeId
:
string
,
isStoreApp
:
boolean
)
:
Promise
<
Response
>
Parameters
scopeId
:
string
isStoreApp
:
boolean
Returns
Promise
<
Response
>
unload
Dependent
Records
unloadDependentRecords
(
request
:
BatchUnloadRequest
)
:
Promise
<
UnloadedRecord
[]
>
Parameters
request
:
BatchUnloadRequest
Returns
Promise
<
UnloadedRecord
[]
>
unloadDependentRecords
<
T
extends
string
>
(
table
:
T
,
sysId
:
string
,
tableGraphs
:
RelationshipHierarchy
<
T
>
[]
,
scopeId
?:
string
,
)
:
Promise
<
UnloadedRecord
[]
>
Type Parameters
T
extends
string
Parameters
table
:
T
sysId
:
string
tableGraphs
:
RelationshipHierarchy
<
T
>
[]
Optional
scopeId
:
string
Returns
Promise
<
UnloadedRecord
[]
>
Deprecated
Use the single request object form instead
unload
Records
unloadRecords
(
sysIds
:
string
[]
,
scopeId
:
string
)
:
Promise
<
UnloadedRecord
[]
>
Parameters
sysIds
:
string
[]
scopeId
:
string
Returns
Promise
<
UnloadedRecord
[]
>
upload
Scoped
App
Package
uploadScopedAppPackage
(
file
:
Blob
,
options
:
{
appInfo
?:
{
scope
:
string
;
scopeId
:
string
;
version
:
string
}
;
installAsync
?:
boolean
;
isStoreApp
?:
boolean
;
loadDemoData
?:
boolean
;
registerScope
?:
boolean
;
timeoutMs
?:
number
;
}
,
)
:
Promise
<
{
rollbackId
:
string
;
trackerId
:
string
}
|
undefined
>
Parameters
file
:
Blob
options
:
{
appInfo
?:
{
scope
:
string
;
scopeId
:
string
;
version
:
string
}
;
installAsync
?:
boolean
;
isStoreApp
?:
boolean
;
loadDemoData
?:
boolean
;
registerScope
?:
boolean
;
timeoutMs
?:
number
;
}
Returns
Promise
<
{
rollbackId
:
string
;
trackerId
:
string
}
|
undefined
>
upload
Xml
Files
uploadXmlFiles
(
scope
:
string
,
files
:
{
blob
:
Blob
;
name
:
string
}
[]
,
options
?:
{
targetUpdateSetId
?:
string
;
timeoutMs
?:
number
}
,
)
:
Promise
<
string
>
Parameters
scope
:
string
files
:
{
blob
:
Blob
;
name
:
string
}
[]
Optional
options
:
{
targetUpdateSetId
?:
string
;
timeoutMs
?:
number
}
Returns
Promise
<
string
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
app
Creator
Vendor
Prefix
app
Upgrade
Status
download
download
Update
Set
fetch
get
Host
get
Instance
Build
Name
get
Progress
get
Scope
Info
get
Update
Mutex
get
Update
XML
Count
move
To
App
processor
Request
set
Current
Application
syntax
Editor
Cache
Script
Includes
syntax
Editor
Completion
Definitions
syntax
Editor
Definitions
Script
Includes
uninstall
Application
unload
Dependent
Records
unload
Records
upload
Scoped
App
Package
upload
Xml
Files
@servicenow/sdk - v4.7.0
Loading...
Deprecated
Use the single request object form instead