jira.js
Guide
GitHub
Preparing search index...
assets
createAssetsClient
Function createAssetsClient
createAssetsClient
(
config
:
AssetsClientConfig
,
)
:
{
connectedTickets
:
{
findObjectTickets
:
(
parameters
:
{
objectId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
allTicketsQuery
:
string
;
tickets
?:
{
created
:
Date
;
globalId
:
string
;
id
:
string
;
key
?:
string
;
priority
:
{
iconUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
}
;
reporter
:
string
;
status
?:
{
colorName
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
title
?:
string
;
type
:
{
description
?:
string
;
iconUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
globalConfig
:
{
updateGlobalConfiguration
:
(
parameters
:
{
allowOtherObjectSchema
?:
boolean
;
id
:
string
;
quickCreateObjects
?:
boolean
;
validateQuickCreate
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
icons
:
{
findGlobalIcons
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIcon
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIconImage
:
(
parameters
:
{
id
:
string
;
size
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
ArrayBuffer
|
ArrayBufferView
<
ArrayBufferLike
>
>
;
}
;
imports
:
{
startImport
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actor
?:
string
;
category
?:
string
;
currentStep
?:
number
;
currentStepTotalWorkUnits
?:
number
;
currentWorkDescription
?:
string
;
currentWorkUnits
?:
number
;
estimatedFinishDate
?:
Date
;
executionUUID
?:
string
;
finishedDate
?:
Date
;
numberOfSteps
?:
number
;
progressInPercent
?:
number
;
resourceId
?:
string
;
result
?:
string
;
resultData
?:
Record
<
string
,
any
>
;
resultMessage
?:
string
;
startDate
?:
Date
;
status
?:
string
;
stepDescription
?:
string
;
totalWorkUnits
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
importSources
:
{
cancelImportExecution
:
(
parameters
:
{
importExecutionId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createFailedImportHistory
:
(
parameters
:
{
body
?:
Record
<
string
,
any
>
;
executionId
:
string
;
importSourceId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createImportSchedule
:
(
parameters
:
{
callbackUrl
?:
string
|
null
;
importSourceId
:
string
;
runInterval
:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
:
unknown
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
id
?:
string
;
importSourceId
?:
string
;
runInterval
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
updated
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteImportSchedule
:
(
parameters
:
{
importScheduleId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
generateImportSourceToken
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getImportConfigurationStatus
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getImportExecutionStatus
:
(
parameters
:
{
importExecutionId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getImportSchedule
:
(
parameters
:
{
importScheduleId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
id
?:
string
;
importSourceId
?:
string
;
runInterval
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
updated
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
getImportScheduleLinks
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
links
?:
{
createSchedule
:
string
;
schedule
?:
string
;
[
key
:
string
]:
unknown
;
}
;
result
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getImportSource
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
dateFormat
?:
string
;
dateTimeFormat
?:
string
;
defaultConcatenator
?:
string
;
defaultHandleComputeIssueValues
?:
string
|
null
;
defaultHandleEmptyValues
?:
string
;
defaultHandleNotMappedValues
?:
string
|
null
;
defaultHandleNullValues
?:
string
|
null
;
defaultHandleUnknownValues
?:
string
;
description
?:
string
|
null
;
id
?:
string
;
importExecutionType
?:
string
|
null
;
importSourceModuleKey
?:
|
string
&
{}
|
"rlabs-import-type-csv"
|
"rlabs-import-type-json"
|
"rlabs-import-type-external"
|
"insight-discovery-import"
|
"rlabs-import-type-dm-csv"
;
importSourceOTEntries
?:
|
{
created
?:
Date
|
null
;
description
?:
string
|
null
;
emptyValues
?:
string
|
null
;
id
?:
string
;
importSourceId
?:
string
|
null
;
importSourceOTAttrEntries
?:
{
id
?:
...
;
[
key
:
...
]:
...
}
[]
|
null
;
importStatus
?:
|
{
configurationStatusType
?:
(...)
|
(...)
|
(...)
|
(...)
;
reasonForInvalidity
?:
(...)
|
(...)
;
validationStatusType
?:
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
|
null
;
matchIdentifierIgnoreCase
?:
boolean
|
null
;
objectType
?:
|
{
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
|
null
;
parentImportSourceOTId
?:
string
|
null
;
selector
?:
string
|
null
;
selectorIQL
?:
string
|
null
;
selectorQlQuery
?:
string
|
null
;
unknownValues
?:
string
|
null
;
updated
?:
Date
|
null
;
[
key
:
string
]:
unknown
;
}
[]
|
null
;
importSpecificConfiguration
?:
string
;
importStatus
?:
|
{
configurationAuiLozenge
?:
string
;
configurationStatusType
?:
string
&
{}
|
"ENABLED"
|
"DISABLED"
|
null
;
name
?:
string
;
reasonForInvalidity
?:
Record
<
string
,
any
>
|
null
;
validation
?:
string
;
validationAuiLozenge
?:
string
;
validationStatusType
?:
|
string
&
{}
|
"VALID"
|
"INVALID_CONFIGURATION"
|
"MODULE_UNINSTALLED"
|
null
;
[
key
:
string
]:
unknown
;
}
|
null
;
integratedImportTypeExtensionId
?:
string
|
null
;
integratedImportTypeId
?:
number
|
null
;
isImportSourceSchedulingEnabled
?:
boolean
|
null
;
name
?:
string
;
objectSchemaId
?:
string
;
scheduledImportDetails
?:
|
{
createdAt
?:
Date
;
importScheduleId
?:
string
;
nextScheduledTime
?:
Date
;
runFrequency
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
|
null
;
tokenGenerated
?:
boolean
|
null
;
updated
?:
Date
;
url
?:
string
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getLatestImportExecutionStatus
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getSchemaAndMapping
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
mapping
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSchemaAndMappingProgress
:
(
parameters
:
{
importSourceId
:
string
;
resourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
startImportExecution
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
submitImportExecutionData
:
(
parameters
:
{
body
?:
Record
<
string
,
any
>
;
importExecutionId
:
string
;
importSourceId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
submitImportExecutionProgress
:
(
parameters
:
{
body
?:
Record
<
string
,
any
>
;
importExecutionId
:
string
;
importSourceId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
submitSchemaAndMapping
:
(
parameters
:
{
async
?:
boolean
;
importSourceId
:
string
;
mapping
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateImportSchedule
:
(
parameters
:
{
callbackUrl
?:
string
|
null
;
importScheduleId
:
string
;
importSourceId
:
string
;
runInterval
:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
:
unknown
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
id
?:
string
;
importSourceId
?:
string
;
runInterval
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
updated
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateSchemaAndMapping
:
(
parameters
:
{
async
?:
boolean
;
importSourceId
:
string
;
mapping
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
objects
:
{
countObjectsByAql
:
(
parameters
:
{
qlQuery
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
totalCount
?:
number
;
[
key
:
string
]:
unknown
}
>
;
createObject
:
(
parameters
:
{
attributes
:
{
objectAttributeValues
:
{
value
:
string
;
[
key
:
string
]:
unknown
}
[]
;
objectTypeAttributeId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatarUUID
?:
string
;
hasAvatar
?:
boolean
;
objectTypeId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
{
additionalValue
?:
(...)
|
(...)
;
displayValue
:
string
;
group
?:
(...)
|
(...)
;
referencedObject
?:
(...)
|
(...)
;
searchValue
?:
(...)
|
(...)
;
status
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
value
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
(...)
|
(...)
;
defaultType
?:
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
editable
?:
(...)
|
(...)
|
(...)
;
globalId
:
string
;
hidden
?:
(...)
|
(...)
|
(...)
;
id
:
string
;
includeChildObjectTypes
?:
(...)
|
(...)
|
(...)
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
(...)
|
(...)
;
minimumCardinality
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
objectType
?:
(...)
|
(...)
;
options
?:
(...)
|
(...)
;
position
:
number
;
qlQuery
?:
(...)
|
(...)
;
referenceObjectType
?:
(...)
|
(...)
;
referenceObjectTypeId
?:
(...)
|
(...)
;
referenceType
?:
(...)
|
(...)
;
regexValidation
?:
(...)
|
(...)
;
removable
?:
(...)
|
(...)
|
(...)
;
sortable
?:
(...)
|
(...)
|
(...)
;
suffix
?:
(...)
|
(...)
;
summable
?:
(...)
|
(...)
|
(...)
;
system
?:
(...)
|
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
typeValue
?:
(...)
|
(...)
;
typeValueMulti
?:
(...)
|
(...)
;
uniqueAttribute
?:
(...)
|
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteObject
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
findObjectAttributes
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
objectAttributeValues
:
{
additionalValue
?:
string
;
displayValue
:
string
;
group
?:
{
avatarUrl
:
string
;
name
:
string
;
[
key
:
string
]:
unknown
}
;
referencedObject
?:
Record
<
string
,
any
>
;
searchValue
?:
string
;
status
?:
{
category
:
number
;
description
?:
(...)
|
(...)
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
user
?:
{
avatarUrl
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
html
?:
(...)
|
(...)
;
isDeleted
?:
(...)
|
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastSeenVersion
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
renderedLink
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
value
?:
string
|
Date
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
(...)
|
(...)
;
globalId
:
string
;
icon
:
{
id
:
...
;
name
:
...
;
url16
:
...
;
url48
:
...
;
[
key
:
...
]:
...
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
(...)
|
(...)
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
(...)
|
(...)
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
(...)
|
(...)
;
globalId
:
string
;
icon
:
{
id
:
...
;
name
:
...
;
url16
:
...
;
url48
:
...
;
[
key
:
...
]:
...
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
(...)
|
(...)
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
(...)
|
(...)
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
(...)
|
(...)
;
color
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
globalId
:
string
;
id
?:
(...)
|
(...)
;
name
:
string
;
objectSchemaId
?:
(...)
|
(...)
;
url16
?:
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findObjectHistory
:
(
parameters
:
{
asc
?:
boolean
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actor
:
{
avatarUrl
?:
string
;
displayName
?:
string
;
emailAddress
?:
string
;
html
?:
string
;
isDeleted
?:
boolean
;
key
?:
string
;
lastSeenVersion
?:
string
;
name
?:
string
;
renderedLink
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
affectedAttribute
?:
string
;
created
:
Date
;
id
:
string
;
newValue
?:
string
;
objectId
:
string
;
oldValue
?:
string
;
type
:
number
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findObjectReferenceInfo
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
numberOfReferencedObjects
:
number
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
openIssuesExists
:
boolean
;
referenceTypes
?:
{
cdmData
?:
{
types
?:
...
;
[
key
:
...
]:
...
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findObjectsByAql
:
(
parameters
:
{
includeAttributes
?:
boolean
;
maxResults
?:
number
;
qlQuery
:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
last
:
boolean
;
maxResults
:
number
;
objectTypeAttributes
:
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
...
;
[
key
:
...
]:
...
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
startAt
:
number
;
values
:
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
(...)
[]
;
objectTypeAttribute
?:
(...)
|
(...)
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
loadObject
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
{
additionalValue
?:
(...)
|
(...)
;
displayValue
:
string
;
group
?:
(...)
|
(...)
;
referencedObject
?:
(...)
|
(...)
;
searchValue
?:
(...)
|
(...)
;
status
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
value
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
(...)
|
(...)
;
defaultType
?:
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
editable
?:
(...)
|
(...)
|
(...)
;
globalId
:
string
;
hidden
?:
(...)
|
(...)
|
(...)
;
id
:
string
;
includeChildObjectTypes
?:
(...)
|
(...)
|
(...)
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
(...)
|
(...)
;
minimumCardinality
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
objectType
?:
(...)
|
(...)
;
options
?:
(...)
|
(...)
;
position
:
number
;
qlQuery
?:
(...)
|
(...)
;
referenceObjectType
?:
(...)
|
(...)
;
referenceObjectTypeId
?:
(...)
|
(...)
;
referenceType
?:
(...)
|
(...)
;
regexValidation
?:
(...)
|
(...)
;
removable
?:
(...)
|
(...)
|
(...)
;
sortable
?:
(...)
|
(...)
|
(...)
;
suffix
?:
(...)
|
(...)
;
summable
?:
(...)
|
(...)
|
(...)
;
system
?:
(...)
|
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
typeValue
?:
(...)
|
(...)
;
typeValueMulti
?:
(...)
|
(...)
;
uniqueAttribute
?:
(...)
|
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateObject
:
(
parameters
:
{
attributes
:
{
objectAttributeValues
:
{
value
:
string
;
[
key
:
string
]:
unknown
}
[]
;
objectTypeAttributeId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatarUUID
?:
string
;
hasAvatar
?:
boolean
;
id
:
string
;
objectTypeId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
{
additionalValue
?:
(...)
|
(...)
;
displayValue
:
string
;
group
?:
(...)
|
(...)
;
referencedObject
?:
(...)
|
(...)
;
searchValue
?:
(...)
|
(...)
;
status
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
value
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
(...)
|
(...)
;
defaultType
?:
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
editable
?:
(...)
|
(...)
|
(...)
;
globalId
:
string
;
hidden
?:
(...)
|
(...)
|
(...)
;
id
:
string
;
includeChildObjectTypes
?:
(...)
|
(...)
|
(...)
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
(...)
|
(...)
;
minimumCardinality
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
objectType
?:
(...)
|
(...)
;
options
?:
(...)
|
(...)
;
position
:
number
;
qlQuery
?:
(...)
|
(...)
;
referenceObjectType
?:
(...)
|
(...)
;
referenceObjectTypeId
?:
(...)
|
(...)
;
referenceType
?:
(...)
|
(...)
;
regexValidation
?:
(...)
|
(...)
;
removable
?:
(...)
|
(...)
|
(...)
;
sortable
?:
(...)
|
(...)
|
(...)
;
suffix
?:
(...)
|
(...)
;
summable
?:
(...)
|
(...)
|
(...)
;
system
?:
(...)
|
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
typeValue
?:
(...)
|
(...)
;
typeValueMulti
?:
(...)
|
(...)
;
uniqueAttribute
?:
(...)
|
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
objectSchemas
:
{
createSchema
:
(
parameters
:
{
description
?:
string
;
name
:
string
;
objectSchemaKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteSchema
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findSchemaAttributes
:
(
parameters
:
{
extended
?:
boolean
;
id
:
string
;
onlyValueEditable
?:
boolean
;
query
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findSchemaObjectTypes
:
(
parameters
:
{
excludeAbstract
?:
boolean
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findSchemaObjectTypesFlat
:
(
parameters
:
{
exclude
?:
string
;
id
:
string
;
includeObjectCounts
?:
boolean
;
query
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findSchemas
:
(
parameters
?:
{
includeCounts
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
last
?:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
loadSchema
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateSchema
:
(
parameters
:
{
description
?:
string
;
id
:
string
;
name
?:
string
;
objectSchemaKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
objectTypeAttributes
:
{
createObjectTypeAttribute
:
(
parameters
:
{
additionalValue
?:
string
;
defaultTypeId
?:
number
;
description
?:
string
;
hidden
?:
boolean
;
includeChildObjectTypes
?:
boolean
;
label
?:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
:
string
;
objectTypeId
:
string
;
options
?:
string
;
qlQuery
?:
string
;
regexValidation
?:
string
;
suffix
?:
string
;
summable
?:
boolean
;
type
:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteObjectTypeAttribute
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateObjectTypeAttribute
:
(
parameters
:
{
additionalValue
?:
string
;
defaultTypeId
?:
number
;
description
?:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
label
?:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectTypeId
:
string
;
options
?:
string
;
qlQuery
?:
string
;
regexValidation
?:
string
;
suffix
?:
string
;
summable
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
objectTypes
:
{
changeObjectTypePosition
:
(
parameters
:
{
id
:
string
;
position
:
number
;
toObjectTypeId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createObjectType
:
(
parameters
:
{
abstractObjectType
?:
boolean
;
description
?:
string
;
iconId
:
string
;
inherited
?:
boolean
;
name
:
string
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteObjectType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findObjectTypeAttributes
:
(
parameters
:
{
excludeParentAttributes
?:
boolean
;
id
:
string
;
includeChildren
?:
boolean
;
includeValuesExist
?:
boolean
;
onlyValueEditable
?:
boolean
;
orderByName
?:
boolean
;
orderByRequired
?:
boolean
;
query
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
loadObjectType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateObjectType
:
(
parameters
:
{
abstractObjectType
?:
boolean
;
description
?:
string
;
iconId
?:
string
;
id
:
string
;
inherited
?:
boolean
;
name
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
progress
:
{
getImportProgress
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actor
?:
string
;
category
?:
string
;
currentStep
?:
number
;
currentStepTotalWorkUnits
?:
number
;
currentWorkDescription
?:
string
;
currentWorkUnits
?:
number
;
estimatedFinishDate
?:
Date
;
executionUUID
?:
string
;
finishedDate
?:
Date
;
numberOfSteps
?:
number
;
progressInPercent
?:
number
;
resourceId
?:
string
;
result
?:
string
;
resultData
?:
Record
<
string
,
any
>
;
resultMessage
?:
string
;
startDate
?:
Date
;
status
?:
string
;
stepDescription
?:
string
;
totalWorkUnits
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
referenceTypes
:
{
createReferenceType
:
(
parameters
:
{
color
?:
string
;
description
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
cdmData
?:
{
types
?:
{
key
?:
(...)
|
(...)
;
opinionated
?:
(...)
|
(...)
|
(...)
;
version
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findReferenceTypes
:
(
parameters
?:
{
includeAll
?:
boolean
;
objectSchemaId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
cdmData
?:
{
types
?:
{
key
?:
...
;
opinionated
?:
...
;
version
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
statusTypes
:
{
createStatusType
:
(
parameters
:
{
category
:
number
;
description
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteStatusType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
findStatusTypes
:
(
parameters
?:
{
objectSchemaId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getStatusType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateStatusType
:
(
parameters
:
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
usage
:
{
getTenantUsageInfo
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
perSchemaUsageInfo
:
{
objectCount
:
number
;
schemaCreatedAt
:
Date
;
schemaId
:
number
;
schemaName
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
totalObjectsCount
:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
}
Parameters
config
:
AssetsClientConfig
Returns
{
connectedTickets
:
{
findObjectTickets
:
(
parameters
:
{
objectId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
allTicketsQuery
:
string
;
tickets
?:
{
created
:
Date
;
globalId
:
string
;
id
:
string
;
key
?:
string
;
priority
:
{
iconUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
}
;
reporter
:
string
;
status
?:
{
colorName
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
title
?:
string
;
type
:
{
description
?:
string
;
iconUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
globalConfig
:
{
updateGlobalConfiguration
:
(
parameters
:
{
allowOtherObjectSchema
?:
boolean
;
id
:
string
;
quickCreateObjects
?:
boolean
;
validateQuickCreate
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
icons
:
{
findGlobalIcons
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIcon
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIconImage
:
(
parameters
:
{
id
:
string
;
size
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
ArrayBuffer
|
ArrayBufferView
<
ArrayBufferLike
>
>
;
}
;
imports
:
{
startImport
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actor
?:
string
;
category
?:
string
;
currentStep
?:
number
;
currentStepTotalWorkUnits
?:
number
;
currentWorkDescription
?:
string
;
currentWorkUnits
?:
number
;
estimatedFinishDate
?:
Date
;
executionUUID
?:
string
;
finishedDate
?:
Date
;
numberOfSteps
?:
number
;
progressInPercent
?:
number
;
resourceId
?:
string
;
result
?:
string
;
resultData
?:
Record
<
string
,
any
>
;
resultMessage
?:
string
;
startDate
?:
Date
;
status
?:
string
;
stepDescription
?:
string
;
totalWorkUnits
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
importSources
:
{
cancelImportExecution
:
(
parameters
:
{
importExecutionId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createFailedImportHistory
:
(
parameters
:
{
body
?:
Record
<
string
,
any
>
;
executionId
:
string
;
importSourceId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createImportSchedule
:
(
parameters
:
{
callbackUrl
?:
string
|
null
;
importSourceId
:
string
;
runInterval
:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
:
unknown
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
id
?:
string
;
importSourceId
?:
string
;
runInterval
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
updated
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteImportSchedule
:
(
parameters
:
{
importScheduleId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
generateImportSourceToken
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getImportConfigurationStatus
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getImportExecutionStatus
:
(
parameters
:
{
importExecutionId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getImportSchedule
:
(
parameters
:
{
importScheduleId
:
string
;
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
id
?:
string
;
importSourceId
?:
string
;
runInterval
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
updated
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
getImportScheduleLinks
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
links
?:
{
createSchedule
:
string
;
schedule
?:
string
;
[
key
:
string
]:
unknown
;
}
;
result
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getImportSource
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
dateFormat
?:
string
;
dateTimeFormat
?:
string
;
defaultConcatenator
?:
string
;
defaultHandleComputeIssueValues
?:
string
|
null
;
defaultHandleEmptyValues
?:
string
;
defaultHandleNotMappedValues
?:
string
|
null
;
defaultHandleNullValues
?:
string
|
null
;
defaultHandleUnknownValues
?:
string
;
description
?:
string
|
null
;
id
?:
string
;
importExecutionType
?:
string
|
null
;
importSourceModuleKey
?:
|
string
&
{}
|
"rlabs-import-type-csv"
|
"rlabs-import-type-json"
|
"rlabs-import-type-external"
|
"insight-discovery-import"
|
"rlabs-import-type-dm-csv"
;
importSourceOTEntries
?:
|
{
created
?:
Date
|
null
;
description
?:
string
|
null
;
emptyValues
?:
string
|
null
;
id
?:
string
;
importSourceId
?:
string
|
null
;
importSourceOTAttrEntries
?:
{
id
?:
...
;
[
key
:
...
]:
...
}
[]
|
null
;
importStatus
?:
|
{
configurationStatusType
?:
(...)
|
(...)
|
(...)
|
(...)
;
reasonForInvalidity
?:
(...)
|
(...)
;
validationStatusType
?:
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
|
null
;
matchIdentifierIgnoreCase
?:
boolean
|
null
;
objectType
?:
|
{
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
|
null
;
parentImportSourceOTId
?:
string
|
null
;
selector
?:
string
|
null
;
selectorIQL
?:
string
|
null
;
selectorQlQuery
?:
string
|
null
;
unknownValues
?:
string
|
null
;
updated
?:
Date
|
null
;
[
key
:
string
]:
unknown
;
}
[]
|
null
;
importSpecificConfiguration
?:
string
;
importStatus
?:
|
{
configurationAuiLozenge
?:
string
;
configurationStatusType
?:
string
&
{}
|
"ENABLED"
|
"DISABLED"
|
null
;
name
?:
string
;
reasonForInvalidity
?:
Record
<
string
,
any
>
|
null
;
validation
?:
string
;
validationAuiLozenge
?:
string
;
validationStatusType
?:
|
string
&
{}
|
"VALID"
|
"INVALID_CONFIGURATION"
|
"MODULE_UNINSTALLED"
|
null
;
[
key
:
string
]:
unknown
;
}
|
null
;
integratedImportTypeExtensionId
?:
string
|
null
;
integratedImportTypeId
?:
number
|
null
;
isImportSourceSchedulingEnabled
?:
boolean
|
null
;
name
?:
string
;
objectSchemaId
?:
string
;
scheduledImportDetails
?:
|
{
createdAt
?:
Date
;
importScheduleId
?:
string
;
nextScheduledTime
?:
Date
;
runFrequency
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
|
null
;
tokenGenerated
?:
boolean
|
null
;
updated
?:
Date
;
url
?:
string
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getLatestImportExecutionStatus
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getSchemaAndMapping
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
mapping
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSchemaAndMappingProgress
:
(
parameters
:
{
importSourceId
:
string
;
resourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
startImportExecution
:
(
parameters
:
{
importSourceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
submitImportExecutionData
:
(
parameters
:
{
body
?:
Record
<
string
,
any
>
;
importExecutionId
:
string
;
importSourceId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
submitImportExecutionProgress
:
(
parameters
:
{
body
?:
Record
<
string
,
any
>
;
importExecutionId
:
string
;
importSourceId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
submitSchemaAndMapping
:
(
parameters
:
{
async
?:
boolean
;
importSourceId
:
string
;
mapping
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateImportSchedule
:
(
parameters
:
{
callbackUrl
?:
string
|
null
;
importScheduleId
:
string
;
importSourceId
:
string
;
runInterval
:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
:
unknown
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
collectionId
?:
string
;
created
?:
Date
;
id
?:
string
;
importSourceId
?:
string
;
runInterval
?:
string
&
{}
|
"ONCE"
|
"DAILY"
|
"WEEKLY"
|
"MONTHLY"
;
startTime
?:
Date
;
updated
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateSchemaAndMapping
:
(
parameters
:
{
async
?:
boolean
;
importSourceId
:
string
;
mapping
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
objects
:
{
countObjectsByAql
:
(
parameters
:
{
qlQuery
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
totalCount
?:
number
;
[
key
:
string
]:
unknown
}
>
;
createObject
:
(
parameters
:
{
attributes
:
{
objectAttributeValues
:
{
value
:
string
;
[
key
:
string
]:
unknown
}
[]
;
objectTypeAttributeId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatarUUID
?:
string
;
hasAvatar
?:
boolean
;
objectTypeId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
{
additionalValue
?:
(...)
|
(...)
;
displayValue
:
string
;
group
?:
(...)
|
(...)
;
referencedObject
?:
(...)
|
(...)
;
searchValue
?:
(...)
|
(...)
;
status
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
value
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
(...)
|
(...)
;
defaultType
?:
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
editable
?:
(...)
|
(...)
|
(...)
;
globalId
:
string
;
hidden
?:
(...)
|
(...)
|
(...)
;
id
:
string
;
includeChildObjectTypes
?:
(...)
|
(...)
|
(...)
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
(...)
|
(...)
;
minimumCardinality
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
objectType
?:
(...)
|
(...)
;
options
?:
(...)
|
(...)
;
position
:
number
;
qlQuery
?:
(...)
|
(...)
;
referenceObjectType
?:
(...)
|
(...)
;
referenceObjectTypeId
?:
(...)
|
(...)
;
referenceType
?:
(...)
|
(...)
;
regexValidation
?:
(...)
|
(...)
;
removable
?:
(...)
|
(...)
|
(...)
;
sortable
?:
(...)
|
(...)
|
(...)
;
suffix
?:
(...)
|
(...)
;
summable
?:
(...)
|
(...)
|
(...)
;
system
?:
(...)
|
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
typeValue
?:
(...)
|
(...)
;
typeValueMulti
?:
(...)
|
(...)
;
uniqueAttribute
?:
(...)
|
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteObject
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
findObjectAttributes
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
objectAttributeValues
:
{
additionalValue
?:
string
;
displayValue
:
string
;
group
?:
{
avatarUrl
:
string
;
name
:
string
;
[
key
:
string
]:
unknown
}
;
referencedObject
?:
Record
<
string
,
any
>
;
searchValue
?:
string
;
status
?:
{
category
:
number
;
description
?:
(...)
|
(...)
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
user
?:
{
avatarUrl
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
html
?:
(...)
|
(...)
;
isDeleted
?:
(...)
|
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastSeenVersion
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
renderedLink
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
value
?:
string
|
Date
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
(...)
|
(...)
;
globalId
:
string
;
icon
:
{
id
:
...
;
name
:
...
;
url16
:
...
;
url48
:
...
;
[
key
:
...
]:
...
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
(...)
|
(...)
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
(...)
|
(...)
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
(...)
|
(...)
;
globalId
:
string
;
icon
:
{
id
:
...
;
name
:
...
;
url16
:
...
;
url48
:
...
;
[
key
:
...
]:
...
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
(...)
|
(...)
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
(...)
|
(...)
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
(...)
|
(...)
;
color
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
globalId
:
string
;
id
?:
(...)
|
(...)
;
name
:
string
;
objectSchemaId
?:
(...)
|
(...)
;
url16
?:
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findObjectHistory
:
(
parameters
:
{
asc
?:
boolean
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actor
:
{
avatarUrl
?:
string
;
displayName
?:
string
;
emailAddress
?:
string
;
html
?:
string
;
isDeleted
?:
boolean
;
key
?:
string
;
lastSeenVersion
?:
string
;
name
?:
string
;
renderedLink
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
affectedAttribute
?:
string
;
created
:
Date
;
id
:
string
;
newValue
?:
string
;
objectId
:
string
;
oldValue
?:
string
;
type
:
number
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findObjectReferenceInfo
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
numberOfReferencedObjects
:
number
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
openIssuesExists
:
boolean
;
referenceTypes
?:
{
cdmData
?:
{
types
?:
...
;
[
key
:
...
]:
...
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findObjectsByAql
:
(
parameters
:
{
includeAttributes
?:
boolean
;
maxResults
?:
number
;
qlQuery
:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
last
:
boolean
;
maxResults
:
number
;
objectTypeAttributes
:
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
...
;
[
key
:
...
]:
...
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
startAt
:
number
;
values
:
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
(...)
[]
;
objectTypeAttribute
?:
(...)
|
(...)
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
loadObject
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
{
additionalValue
?:
(...)
|
(...)
;
displayValue
:
string
;
group
?:
(...)
|
(...)
;
referencedObject
?:
(...)
|
(...)
;
searchValue
?:
(...)
|
(...)
;
status
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
value
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
(...)
|
(...)
;
defaultType
?:
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
editable
?:
(...)
|
(...)
|
(...)
;
globalId
:
string
;
hidden
?:
(...)
|
(...)
|
(...)
;
id
:
string
;
includeChildObjectTypes
?:
(...)
|
(...)
|
(...)
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
(...)
|
(...)
;
minimumCardinality
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
objectType
?:
(...)
|
(...)
;
options
?:
(...)
|
(...)
;
position
:
number
;
qlQuery
?:
(...)
|
(...)
;
referenceObjectType
?:
(...)
|
(...)
;
referenceObjectTypeId
?:
(...)
|
(...)
;
referenceType
?:
(...)
|
(...)
;
regexValidation
?:
(...)
|
(...)
;
removable
?:
(...)
|
(...)
|
(...)
;
sortable
?:
(...)
|
(...)
|
(...)
;
suffix
?:
(...)
|
(...)
;
summable
?:
(...)
|
(...)
|
(...)
;
system
?:
(...)
|
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
typeValue
?:
(...)
|
(...)
;
typeValueMulti
?:
(...)
|
(...)
;
uniqueAttribute
?:
(...)
|
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateObject
:
(
parameters
:
{
attributes
:
{
objectAttributeValues
:
{
value
:
string
;
[
key
:
string
]:
unknown
}
[]
;
objectTypeAttributeId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatarUUID
?:
string
;
hasAvatar
?:
boolean
;
id
:
string
;
objectTypeId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
_links
:
{
self
:
string
;
[
key
:
string
]:
unknown
}
;
attributes
?:
{
objectAttributeValues
:
{
additionalValue
?:
(...)
|
(...)
;
displayValue
:
string
;
group
?:
(...)
|
(...)
;
referencedObject
?:
(...)
|
(...)
;
searchValue
?:
(...)
|
(...)
;
status
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
value
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
objectTypeAttribute
?:
{
additionalValue
?:
(...)
|
(...)
;
defaultType
?:
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
editable
?:
(...)
|
(...)
|
(...)
;
globalId
:
string
;
hidden
?:
(...)
|
(...)
|
(...)
;
id
:
string
;
includeChildObjectTypes
?:
(...)
|
(...)
|
(...)
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
(...)
|
(...)
;
minimumCardinality
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
objectType
?:
(...)
|
(...)
;
options
?:
(...)
|
(...)
;
position
:
number
;
qlQuery
?:
(...)
|
(...)
;
referenceObjectType
?:
(...)
|
(...)
;
referenceObjectTypeId
?:
(...)
|
(...)
;
referenceType
?:
(...)
|
(...)
;
regexValidation
?:
(...)
|
(...)
;
removable
?:
(...)
|
(...)
|
(...)
;
sortable
?:
(...)
|
(...)
|
(...)
;
suffix
?:
(...)
|
(...)
;
summable
?:
(...)
|
(...)
|
(...)
;
system
?:
(...)
|
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
typeValue
?:
(...)
|
(...)
;
typeValueMulti
?:
(...)
|
(...)
;
uniqueAttribute
?:
(...)
|
(...)
|
(...)
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
objectTypeAttributeId
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
avatar
:
{
avatarUUID
?:
string
;
globalId
:
string
;
id
?:
string
;
objectId
:
string
;
url144
:
string
;
url16
:
string
;
url288
:
string
;
url48
:
string
;
url72
:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
created
:
Date
;
globalId
:
string
;
hasAvatar
:
boolean
;
id
:
string
;
label
:
string
;
objectKey
:
string
;
objectType
:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
timestamp
:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
objectSchemas
:
{
createSchema
:
(
parameters
:
{
description
?:
string
;
name
:
string
;
objectSchemaKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteSchema
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findSchemaAttributes
:
(
parameters
:
{
extended
?:
boolean
;
id
:
string
;
onlyValueEditable
?:
boolean
;
query
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findSchemaObjectTypes
:
(
parameters
:
{
excludeAbstract
?:
boolean
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findSchemaObjectTypesFlat
:
(
parameters
:
{
exclude
?:
string
;
id
:
string
;
includeObjectCounts
?:
boolean
;
query
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
findSchemas
:
(
parameters
?:
{
includeCounts
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
last
?:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
loadSchema
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateSchema
:
(
parameters
:
{
description
?:
string
;
id
:
string
;
name
?:
string
;
objectSchemaKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
canManage
?:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
id
:
string
;
name
:
string
;
objectCount
:
number
;
objectSchemaKey
:
string
;
objectTypeCount
:
number
;
status
?:
string
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
objectTypeAttributes
:
{
createObjectTypeAttribute
:
(
parameters
:
{
additionalValue
?:
string
;
defaultTypeId
?:
number
;
description
?:
string
;
hidden
?:
boolean
;
includeChildObjectTypes
?:
boolean
;
label
?:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
:
string
;
objectTypeId
:
string
;
options
?:
string
;
qlQuery
?:
string
;
regexValidation
?:
string
;
suffix
?:
string
;
summable
?:
boolean
;
type
:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteObjectTypeAttribute
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateObjectTypeAttribute
:
(
parameters
:
{
additionalValue
?:
string
;
defaultTypeId
?:
number
;
description
?:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
label
?:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectTypeId
:
string
;
options
?:
string
;
qlQuery
?:
string
;
regexValidation
?:
string
;
suffix
?:
string
;
summable
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
objectTypes
:
{
changeObjectTypePosition
:
(
parameters
:
{
id
:
string
;
position
:
number
;
toObjectTypeId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createObjectType
:
(
parameters
:
{
abstractObjectType
?:
boolean
;
description
?:
string
;
iconId
:
string
;
inherited
?:
boolean
;
name
:
string
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteObjectType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findObjectTypeAttributes
:
(
parameters
:
{
excludeParentAttributes
?:
boolean
;
id
:
string
;
includeChildren
?:
boolean
;
includeValuesExist
?:
boolean
;
onlyValueEditable
?:
boolean
;
orderByName
?:
boolean
;
orderByRequired
?:
boolean
;
query
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
additionalValue
?:
string
;
defaultType
?:
|
{
id
:
-1
;
name
:
"None"
;
[
key
:
string
]:
unknown
}
|
{
id
:
0
;
name
:
"Text"
;
[
key
:
string
]:
unknown
}
|
{
id
:
1
;
name
:
"Integer"
;
[
key
:
string
]:
unknown
}
|
{
id
:
2
;
name
:
"Boolean"
;
[
key
:
string
]:
unknown
}
|
{
id
:
3
;
name
:
"Double"
;
[
key
:
string
]:
unknown
}
|
{
id
:
4
;
name
:
"Date"
;
[
key
:
string
]:
unknown
}
|
{
id
:
5
;
name
:
"Time"
;
[
key
:
string
]:
unknown
}
|
{
id
:
6
;
name
:
"DateTime"
;
[
key
:
string
]:
unknown
}
|
{
id
:
7
;
name
:
"Url"
;
[
key
:
string
]:
unknown
}
|
{
id
:
8
;
name
:
"Email"
;
[
key
:
string
]:
unknown
}
|
{
id
:
9
;
name
:
"Textarea"
;
[
key
:
string
]:
unknown
}
|
{
id
:
10
;
name
:
"Select"
;
[
key
:
string
]:
unknown
}
|
{
id
:
11
;
name
:
"IP Address"
;
[
key
:
string
]:
unknown
}
;
description
?:
string
;
editable
?:
boolean
;
globalId
:
string
;
hidden
?:
boolean
;
id
:
string
;
includeChildObjectTypes
?:
boolean
;
indexed
:
boolean
;
label
:
boolean
;
maximumCardinality
?:
number
;
minimumCardinality
?:
number
;
name
?:
string
;
objectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
options
?:
string
;
position
:
number
;
qlQuery
?:
string
;
referenceObjectType
?:
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
referenceObjectTypeId
?:
string
;
referenceType
?:
{
cdmData
?:
{
types
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
;
regexValidation
?:
string
;
removable
?:
boolean
;
sortable
?:
boolean
;
suffix
?:
string
;
summable
?:
boolean
;
system
?:
boolean
;
type
?:
number
;
typeValue
?:
string
;
typeValueMulti
?:
string
[]
;
uniqueAttribute
?:
boolean
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
loadObjectType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateObjectType
:
(
parameters
:
{
abstractObjectType
?:
boolean
;
description
?:
string
;
iconId
?:
string
;
id
:
string
;
inherited
?:
boolean
;
name
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
abstractObjectType
:
boolean
;
created
:
Date
;
description
?:
string
;
globalId
:
string
;
icon
:
{
id
:
string
;
name
:
string
;
url16
:
string
;
url48
:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
inherited
:
boolean
;
name
:
string
;
objectCount
:
number
;
objectSchemaId
:
string
;
parentObjectTypeId
?:
number
;
parentObjectTypeInherited
:
boolean
;
position
:
number
;
type
?:
number
;
updated
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
progress
:
{
getImportProgress
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actor
?:
string
;
category
?:
string
;
currentStep
?:
number
;
currentStepTotalWorkUnits
?:
number
;
currentWorkDescription
?:
string
;
currentWorkUnits
?:
number
;
estimatedFinishDate
?:
Date
;
executionUUID
?:
string
;
finishedDate
?:
Date
;
numberOfSteps
?:
number
;
progressInPercent
?:
number
;
resourceId
?:
string
;
result
?:
string
;
resultData
?:
Record
<
string
,
any
>
;
resultMessage
?:
string
;
startDate
?:
Date
;
status
?:
string
;
stepDescription
?:
string
;
totalWorkUnits
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
referenceTypes
:
{
createReferenceType
:
(
parameters
:
{
color
?:
string
;
description
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
cdmData
?:
{
types
?:
{
key
?:
(...)
|
(...)
;
opinionated
?:
(...)
|
(...)
|
(...)
;
version
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findReferenceTypes
:
(
parameters
?:
{
includeAll
?:
boolean
;
objectSchemaId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
cdmData
?:
{
types
?:
{
key
?:
...
;
opinionated
?:
...
;
version
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
color
?:
string
;
description
?:
string
;
globalId
:
string
;
id
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
url16
?:
string
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
statusTypes
:
{
createStatusType
:
(
parameters
:
{
category
:
number
;
description
?:
string
;
name
:
string
;
objectSchemaId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteStatusType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
findStatusTypes
:
(
parameters
?:
{
objectSchemaId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getStatusType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateStatusType
:
(
parameters
:
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
category
:
number
;
description
?:
string
;
id
:
string
;
name
:
string
;
objectSchemaId
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
usage
:
{
getTenantUsageInfo
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
perSchemaUsageInfo
:
{
objectCount
:
number
;
schemaCreatedAt
:
Date
;
schemaId
:
number
;
schemaName
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
totalObjectsCount
:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Guide
GitHub
jira.js
Loading...