TIF Admin API

API documentation for the TIF Admin API

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
get /v1/performance/cpu
(cpu)

Return type

CPUData

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response CPUData
Up 
delete /v1/appevents/{id}
(delete)

Path parameters

id (required)
Path Parameter — format: int64

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
delete /v1/appevents/all
(deleteAll)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
delete /v1/jobs/{jobId}
(deleteJob)

Path parameters

jobId (required)
Path Parameter — format: uuid

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
delete /v1/services/{serviceId}/jobs
(deleteJobs)

Path parameters

serviceId (required)
Path Parameter — format: int32

Return type

Integer

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Integer
Up 
delete /v1/configurations/integrations/resource
(deleteResource)

Query parameters

resourceId (optional)
Query Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
delete /v1/services/{serviceId}
(deleteService)

Path parameters

serviceId (required)
Path Parameter — format: int32

Return type

Integer

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Integer
Up 
get /v1/performance/diskspace
(diskspace)

Return type

array[DiskSpaceData]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/payloads/{payloadId}
(download)

Path parameters

payloadId (required)
Path Parameter — format: int64

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/performance/enovia
(enovia)

Return type

ENOVIAData

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ENOVIAData
Up 
get /v1/jobs/export
(exportJobs)

Query parameters

pageStart (optional)
Query Parameter — format: int32
pageSize (optional)
Query Parameter — format: int32
sort (optional)
Query Parameter —
onlyFailed (optional)
Query Parameter —
state (optional)
Query Parameter —
startDate (optional)
Query Parameter — format: date-time
endDate (optional)
Query Parameter — format: date-time
serviceId (optional)
Query Parameter — format: int32
q (optional)
Query Parameter —
format (optional)
Query Parameter —
jobId (optional)
Query Parameter — format: uuid

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/appevents/{id}
(get)

Path parameters

id (required)
Path Parameter — format: int64

Return type

AppEvent

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response AppEvent
Up 
get /v1/loglevels
(get1)

Return type

array[LogLevelInfo]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/performance
(get2)

Return type

PerformanceInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response PerformanceInfo
Up 
get /v1/internals/about
(getAbout)

Return type

LicenseInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response LicenseInfo
Up 
get /v1/internals/clientSettings
(getClientSettings)

Return type

ClientSettings

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ClientSettings
Up 
get /v1/configurations/integrations/resource
(getContent)

Query parameters

resourceId (optional)
Query Parameter —

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response String
Up 
get /v1/configurations/server/resource
(getContent1)

Query parameters

resourceId (optional)
Query Parameter —

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response String
Up 
get /v1/internals/querymode
(getDefaultQueryMode)

Return type

QueryModeSettings

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response QueryModeSettings
Up 
get /v1/destinations/{destinationId}
(getDestination)

Path parameters

destinationId (required)
Path Parameter —

Return type

map[String, Object]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/destinations
(getDestinations)

Query parameters

groupByType (optional)
Query Parameter —

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Object
Up 
get /v1/destinations/types/{type}
(getDestinationsByType)

Path parameters

type (required)
Path Parameter —

Return type

array[map[String, Object]]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/internals/documentation
(getDocumentation)

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Object
Up 
get /v1/jobs/{jobId}/error
(getError)

Path parameters

jobId (required)
Path Parameter — format: uuid

Return type

ErrorInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ErrorInfo
Up 
get /v1/application.wadl/{path}
(getExternalGrammar)

Path parameters

path (required)
Path Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/jobs/{jobId}/payload/inbound
(getInboundPayload)

Path parameters

jobId (required)
Path Parameter — format: uuid

Return type

PayloadInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response PayloadInfo
Up 
get /v1/internals/indexstats
(getIndexStatus)

Query parameters

jobs (optional)
Query Parameter —
payloads (optional)
Query Parameter —

Return type

IndexStatus

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response IndexStatus
Up 
get /v1/jobs/{jobId}
(getJob)

Path parameters

jobId (required)
Path Parameter — format: uuid

Return type

Job

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Job
Up 
get /v1/services/{serviceId}/lastJob
(getLastJob)

Path parameters

serviceId (required)
Path Parameter — format: int32

Return type

Job

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Job
Up 
get /v1/internals/logfiles/{fileName}
(getLogFile)

Path parameters

fileName (required)
Path Parameter —

Query parameters

zip (optional)
Query Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/internals/logfiles
(getLogFiles)

Return type

array[FileInfo]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/configurations/integrations/resourceNamespaces
(getNamespaces)

Return type

array[String]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/configurations/server/resourceNamespaces
(getNamespaces1)

Return type

array[String]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/jobs/{jobId}/payload/outbound
(getOutboundPayload)

Path parameters

jobId (required)
Path Parameter — format: uuid

Return type

PayloadInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response PayloadInfo
Up 
get /v1/jobs/{jobId}/payload
(getPayloadInfos)

Path parameters

jobId (required)
Path Parameter — format: uuid

Return type

PayloadInfos

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response PayloadInfos
Up 
get /v1/configurations/integrations/resourceNames
(getResourceNames)

Query parameters

type (optional)
Query Parameter —
namespace (optional)
Query Parameter —

Return type

array[NameInfo]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/configurations/server/resourceNames
(getResourceNames1)

Query parameters

type (optional)
Query Parameter —
namespace (optional)
Query Parameter —

Return type

array[NameInfo]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/configurations/integrations/resourceTypes
(getResourceTypes)

Query parameters

namespace (optional)
Query Parameter —

Return type

array[ResourceType]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/configurations/server/resourceTypes
(getResourceTypes1)

Query parameters

namespace (optional)
Query Parameter —

Return type

array[ResourceType]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/scheduler/{id}
(getSchedulerInfo)

Path parameters

id (required)
Path Parameter — format: int32

Return type

ScheduledJobInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ScheduledJobInfo
Up 
get /v1/scheduler
(getSchedulerInfo1)

Query parameters

groupId (optional)
Query Parameter —

Return type

map[String, array[ScheduledJobInfo]]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/services/{serviceId}
(getService)

Path parameters

serviceId (required)
Path Parameter — format: int32

Query parameters

includeActivity (optional)
Query Parameter —

Return type

ServiceInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ServiceInfo
Up 
get /v1/serviceactivators/{id}
(getServiceActivatorByID)

Path parameters

id (required)
Path Parameter —

Return type

ServiceActivatorInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ServiceActivatorInfo
Up 
get /v1/serviceactivators
(getServiceActivators)

Return type

array[ServiceActivatorInfo]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/services/{serviceId}/settings
(getServiceSettings)

Path parameters

serviceId (required)
Path Parameter — format: int32

Return type

ServiceSettingsInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ServiceSettingsInfo
Up 
get /v1/services
(getServices)

Query parameters

orderBy (optional)
Query Parameter —
groupBy (optional)
Query Parameter —
includeActivity (optional)
Query Parameter —
type (optional)
Query Parameter —

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Object
Up 
get /v1/statistics
(getStatistics)

Query parameters

state (optional)
Query Parameter —
startDate (optional)
Query Parameter — format: date-time
endDate (optional)
Query Parameter — format: date-time
serviceId (optional)
Query Parameter — format: int32
resolution (optional)
Query Parameter —
maxSteps (optional)
Query Parameter — format: int32
hasError (optional)
Query Parameter —
resolved (optional)
Query Parameter —

Return type

StatsResult

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response StatsResult
Up 
get /v1/jobs/{jobId}/transfers/{destinationId}
(getTransfer)

Path parameters

jobId (required)
Path Parameter — format: uuid
destinationId (required)
Path Parameter —

Return type

JobTransferInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response JobTransferInfo
Up 
get /v1/jobs/transfers/{transferId}
(getTransferById)

Path parameters

transferId (required)
Path Parameter — format: uuid

Return type

JobTransferInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response JobTransferInfo
Up 
get /v1/jobs/transfers/{transferId}/error
(getTransferError)

Path parameters

transferId (required)
Path Parameter — format: uuid

Return type

ErrorInfo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response ErrorInfo
Up 
get /v1/jobs/transfers/{transferId}/response
(getTransferResponse)

Path parameters

transferId (required)
Path Parameter — format: uuid

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/jobs/{jobId}/transfers
(getTransfers)

Path parameters

jobId (required)
Path Parameter — format: uuid

Return type

array[JobTransferInfo]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/application.wadl
(getWadl)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
post /v1/auth/login
(login)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LoginInput (optional)
Body Parameter —

Return type

LoginResult

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response LoginResult
Up 
post /v1/auth/logout
(logout)

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
delete /v1/appevents
(massDelete)

Query parameters

id (optional)
Query Parameter — format: int64

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/performance/memory
(memory)

Return type

MemoryData

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response MemoryData
Up 
get /v1/internals/downloadToken
(newDownloadToken)

Return type

Token

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Token
Up 
post /v1/scheduler
(perform)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SchedulerActionInput (optional)
Body Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
put /v1/serviceactivators/{id}
(perform1)

Path parameters

id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ServiceActivatorInput (optional)
Body Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
post /v1/jobs
(performAction)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateInput (optional)
Body Parameter —

Return type

map[String, Object]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
get /v1/appevents
(query)

Query parameters

pageStart (optional)
Query Parameter — format: int32
pageSize (optional)
Query Parameter — format: int32
sort (optional)
Query Parameter —
eventType (optional)
Query Parameter —

Return type

AppEventQueryResult

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response AppEventQueryResult
Up 
get /v1/jobs
(query1)

Query parameters

pageStart (optional)
Query Parameter — format: int32
pageSize (optional)
Query Parameter — format: int32
sort (optional)
Query Parameter —
onlyFailed (optional)
Query Parameter —
state (optional)
Query Parameter —
startDate (optional)
Query Parameter — format: date-time
endDate (optional)
Query Parameter — format: date-time
serviceId (optional)
Query Parameter — format: int32
q (optional)
Query Parameter —

Return type

JobQueryResult

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response JobQueryResult
Up 
post /v1/internals/reindex
(reindex)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReindexInput (optional)
Body Parameter —

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Object
Up 
post /v1/internals/querymode
(setDefaultQueryMode)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body QueryModeSettings (optional)
Body Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
put /v1/loglevels
(setLogLevel)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LogLevelInfo (optional)
Body Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
post /v1/services/{serviceId}/settings
(setServiceSettings)

Path parameters

serviceId (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ServiceSettingsInfo (optional)
Body Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
put /v1/configurations/integrations/resource
(update)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ResourceInput (optional)
Body Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response

Models

[ Jump to Methods ]

Table of Contents

  1. ActionInput
  2. AppEvent
  3. AppEventQueryResult
  4. CPUData
  5. ClientSettings
  6. ComponentInfo
  7. DateComponents
  8. DateRange
  9. DiskSpaceData
  10. ENOVIAData
  11. ErrorInfo
  12. FileInfo
  13. IndexStatus
  14. IndexingStats
  15. Job
  16. JobQueryResult
  17. JobTransferInfo
  18. KeyValueMap
  19. Label
  20. LicenseInfo
  21. LogLevelInfo
  22. LoginInput
  23. LoginResult
  24. MemoryData
  25. MemoryPool
  26. NameInfo
  27. PayloadInfo
  28. PayloadInfos
  29. PerformanceInfo
  30. ProductInfo
  31. QueryModeSettings
  32. ReindexInput
  33. ResourceInput
  34. ResourceType
  35. ScheduledJobExecutionInfo
  36. ScheduledJobInfo
  37. SchedulerActionInput
  38. SerieObject
  39. Service
  40. ServiceActivatorInfo
  41. ServiceActivatorInput
  42. ServiceInfo
  43. ServiceSettings
  44. ServiceSettingsInfo
  45. SortField
  46. StatsResult
  47. Token
  48. UpdateInput

ActionInput Up

AppEvent Up

id (optional)
Long format: int64
eventType (optional)
String
Enum:
INFORMATION
WARNING
ERROR
FATAL
time (optional)
Date format: date-time
description (optional)
String
details (optional)
String
data (optional)
array[String]

AppEventQueryResult Up

data (optional)
array[AppEvent]
totalSize (optional)
Long format: int64
page (optional)
Integer format: int32
pageCount (optional)
Long format: int64

CPUData Up

systemCpuLoad (optional)
Double format: double

ClientSettings Up

values (optional)
map[String, Object]

ComponentInfo Up

version (optional)
String
id (optional)
String
displayName (optional)
String
licenseType (optional)
String
Enum:
Full
Trial
Development
Unspecified
expiresIn (optional)
Integer format: int32
expiracyDate (optional)
Date format: date-time

DateComponents Up

year (optional)
Boolean
quarter (optional)
Boolean
month (optional)
Boolean
week (optional)
Boolean
day (optional)
Boolean
hour (optional)
Boolean
minute (optional)
Boolean
second (optional)
Boolean

DateRange Up

from (optional)
Long format: int64
to (optional)
Long format: int64

DiskSpaceData Up

name (optional)
String
totalSpace (optional)
Long format: int64
freeSpace (optional)
Long format: int64
unit (optional)
String

ENOVIAData Up

threads (optional)
Integer format: int32
databaseConnects (optional)
Long format: int64
databaseDisconnects (optional)
Long format: int64
statefulServerCalls (optional)
Long format: int64
statelessServerCalls (optional)
Long format: int64
freeTCLInterpretersInPool (optional)
Long format: int64
currentlyUsedTCLInterpreters (optional)
Long format: int64
memoryHighwater (optional)
Long format: int64
memoryAllocated (optional)
Long format: int64
memoryReserved (optional)
Long format: int64
unit (optional)
String
sqlstatementsExecuted (optional)
Long format: int64

ErrorInfo Up

message (optional)
String
details (optional)
String

FileInfo Up

fileName (optional)
String
displaySize (optional)
String
size (optional)
Long format: int64
lastModified (optional)
Long format: int64
url (optional)
String

IndexStatus Up

jobs (optional)
IndexingStats
payloads (optional)
IndexingStats

IndexingStats Up

indexedCount (optional)
Long format: int64
unindexedCount (optional)
Long format: int64
versionMapping (optional)
map[String, Long] format: int64
currentVersion (optional)
Integer format: int32

Job Up

id (optional)
String
status (optional)
String
Enum:
INITIALIZED
STARTED
COMPLETED_SUCCESSFULLY
COMPLETED_WITH_ERRORS
PENDING
AWAITING_REPLY
start (optional)
Date format: date-time
end (optional)
Date format: date-time
errorMessage (optional)
String
errorDetails (optional)
String
service (optional)
Service
resolved (optional)
Boolean
resolvedDesc (optional)
String
indexerVersion (optional)
Integer format: int32
created (optional)
Date format: date-time
completed (optional)
Date format: date-time
jobId (optional)
UUID format: uuid
lastIndexed (optional)
Date format: date-time
execTime (optional)
Long format: int64

JobQueryResult Up

data (optional)
array[Job]
totalSize (optional)
Long format: int64
page (optional)
Integer format: int32
pageCount (optional)
Long format: int64

JobTransferInfo Up

jobId (optional)
UUID format: uuid
destinationId (optional)
String
transferred (optional)
Boolean
started (optional)
Date format: date-time
completed (optional)
Date format: date-time
retryAttempt (optional)
Integer format: int32
responseData (optional)
PayloadInfo
responseMetaData (optional)
KeyValueMap
errorMessage (optional)
String
errorDetails (optional)
String
transferProperties (optional)
KeyValueMap
maxRetryAttempts (optional)
Integer format: int32

KeyValueMap Up

empty (optional)
Boolean
entries (optional)
Object

Label Up

text (optional)
String
value (optional)
String
timestamp (optional)
Long format: int64
range (optional)
DateRange

LicenseInfo Up

tif (optional)
ProductInfo
tvc (optional)
ProductInfo

LogLevelInfo Up

name (optional)
String
level (optional)
String
Enum:
DEFAULT
OFF
ALL
DEBUG
TRACE
ERROR
INFO
WARNING

LoginInput Up

username (optional)
String
password (optional)
String

LoginResult Up

token (optional)
Token

MemoryData Up

freeMemory (optional)
Long format: int64
maxMemory (optional)
Long format: int64
totalMemory (optional)
Long format: int64
collectionCount (optional)
Long format: int64
collectionTime (optional)
Long format: int64
memoryPools (optional)
array[MemoryPool]
timestamp (optional)
Long format: int64
unit (optional)
String

MemoryPool Up

name (optional)
String
heap (optional)
Boolean
maxMemory (optional)
Long format: int64
usedMemory (optional)
Long format: int64

NameInfo Up

name (optional)
String
readOnly (optional)
Boolean
kind (optional)
String

PayloadInfo Up

id (optional)
Long format: int64
payloadDataType (optional)
String
Enum:
OUTBOUND
INBOUND
contentType (optional)
String
encoding (optional)
String
size (optional)
Long format: int64
downloadURL (optional)
String
content (optional)
String
noDisplayReason (optional)
String
Enum:
NO_REASON
BINARY
TOO_LARGE
NOT_AVAILABLE

PayloadInfos Up

inbound (optional)
PayloadInfo
outbound (optional)
PayloadInfo

PerformanceInfo Up

time (optional)
Long format: int64
cpuData (optional)
CPUData
diskspaceData (optional)
array[DiskSpaceData]
enoviaData (optional)
ENOVIAData
memoryData (optional)
MemoryData
reloadDelay (optional)
Integer format: int32

ProductInfo Up

components (optional)
array[ComponentInfo]
displayName (optional)
String
id (optional)
String
version (optional)
String

QueryModeSettings Up

mode (optional)
String
Enum:
disabled
index
database

ReindexInput Up

startTime (optional)
Long format: int64
endTime (optional)
Long format: int64
indexJobs (optional)
Boolean
indexPayloads (optional)
Boolean

ResourceInput Up

resourceId (optional)
String
newResourceId (optional)
String
overwrite (optional)
Boolean
data (optional)
String

ResourceType Up

name (optional)
String
kind (optional)
String
Enum:
XML
JAVASCRIPT
TEXT
JSON
ANY
readOnly (optional)
Boolean
aliases (optional)
Object
xsd (optional)
String
createNewTemplate (optional)
String
defaultExtension (optional)
String

ScheduledJobExecutionInfo Up

id (optional)
Long format: int64
start (optional)
Date format: date-time
end (optional)
Date format: date-time
errorMessage (optional)
String
errorDetails (optional)
String
result (optional)
String
Enum:
FAILED
SUCCEEDED
resultMessage (optional)
String
jobInfo (optional)
ScheduledJobInfo

ScheduledJobInfo Up

id (optional)
Integer format: int32
groupId (optional)
String
jobId (optional)
String
description (optional)
String
kind (optional)
String
Enum:
JOBCFG
MQL
JAVA
SCRIPT
cronExpression (optional)
String
executions (optional)
array[ScheduledJobExecutionInfo]
lastExecution (optional)
ScheduledJobExecutionInfo
running (optional)
Boolean
disabled (optional)
Boolean

SchedulerActionInput Up

groupId (optional)
String
jobId (optional)
String
action (optional)
String
Enum:
NOOP
PAUSE
RESUME
TRIGGER

SerieObject Up

status (optional)
String
Enum:
INITIALIZED
STARTED
COMPLETED_SUCCESSFULLY
COMPLETED_WITH_ERRORS
PENDING
AWAITING_REPLY
values (optional)
array[Object]

Service Up

id (optional)
Integer format: int32
type (optional)
String
Enum:
ENOVIA
MESSAGING
AMQP
JMS
MQ
SOAP
REST
FILE
name (optional)
String
displayName (optional)
String
configRef (optional)
String
settings (optional)
ServiceSettings

ServiceActivatorInfo Up

id (optional)
String
description (optional)
String
running (optional)
Boolean
stopped (optional)
Boolean

ServiceActivatorInput Up

action (optional)
String
Enum:
START
STOP
NOOP

ServiceInfo Up

id (optional)
Integer format: int32
name (optional)
String
displayName (optional)
String
configRef (optional)
String
type (optional)
String
Enum:
ENOVIA
MESSAGING
AMQP
JMS
MQ
SOAP
REST
FILE
jobsInProcess (optional)
Long format: int64
lastCompleted (optional)
Long format: int64
lastError (optional)
Long format: int64
totalUsage (optional)
Long format: int64
lastCreated (optional)
Long format: int64
lastActivity (optional)
Long format: int64

ServiceSettings Up

serviceId (optional)
Integer format: int32
logKeepDays (optional)
Integer format: int32
logPayload (optional)
Boolean

ServiceSettingsInfo Up

logPayload (optional)
Boolean
logKeepDays (optional)
Integer format: int32

SortField Up

field (optional)
String
direction (optional)
String
Enum:
ASC
DESC

StatsResult Up

labels (optional)
array[Label]
series (optional)
array[SerieObject]
resolution (optional)
String
Enum:
SECOND
SECONDS5
SECONDS15
MINUTE
MINUTES5
MINUTES15
HOUR
HOURS2
DAY
WEEK
MONTH
QUARTER
YEAR
availableResolutions (optional)
array[String]
Enum:
dateFormat (optional)
String
dateComponents (optional)
DateComponents

Token Up

type (optional)
String
value (optional)
String

UpdateInput Up

create (optional)
ActionInput
resolve (optional)
ActionInput
unresolve (optional)
ActionInput
resend (optional)
ActionInput
delete (optional)
ActionInput
abort (optional)
ActionInput