TIF Admin API
API documentation for the TIF Admin API
Access
[ Jump to Models ]
Table of Contents
Up
get /v1/performance/cpu
(cpu)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
delete /v1/appevents/all
(deleteAll)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Integer
Up
get /v1/performance/diskspace
(diskspace)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/performance/enovia
(enovia)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
ENOVIAData
(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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/appevents/{id}
(get)
Path parameters
id (required)
Path Parameter — format: int64
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
AppEvent
(get1)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
(get2)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
PerformanceInfo
Up
get /v1/internals/about
(getAbout)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
LicenseInfo
Up
get /v1/internals/clientSettings
(getClientSettings)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
String
Up
get /v1/internals/querymode
(getDefaultQueryMode)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
(getDestinations)
Query parameters
groupByType (optional)
Query Parameter —
Return type
Object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Object
Up
get /v1/jobs/{jobId}/error
(getError)
Path parameters
jobId (required)
Path Parameter — format: uuid
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/jobs/{jobId}/payload/inbound
(getInboundPayload)
Path parameters
jobId (required)
Path Parameter — format: uuid
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
IndexStatus
(getJob)
Path parameters
jobId (required)
Path Parameter — format: uuid
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Job
Up
get /v1/services/{serviceId}/lastJob
(getLastJob)
Path parameters
serviceId (required)
Path Parameter — format: int32
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/internals/logfiles
(getLogFiles)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/jobs/{jobId}/payload/outbound
(getOutboundPayload)
Path parameters
jobId (required)
Path Parameter — format: uuid
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
PayloadInfo
Up
get /v1/jobs/{jobId}/payload
(getPayloadInfos)
Path parameters
jobId (required)
Path Parameter — format: uuid
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/configurations/integrations/resourceTypes
(getResourceTypes)
Query parameters
namespace (optional)
Query Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/configurations/server/resourceTypes
(getResourceTypes1)
Query parameters
namespace (optional)
Query Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/scheduler/{id}
(getSchedulerInfo)
Path parameters
id (required)
Path Parameter — format: int32
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
ScheduledJobInfo
(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 request header;
the media type will be conveyed by the 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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
ServiceInfo
Up
get /v1/serviceactivators/{id}
(getServiceActivatorByID)
Path parameters
id (required)
Path Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
ServiceActivatorInfo
Up
get /v1/serviceactivators
(getServiceActivators)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/services/{serviceId}/settings
(getServiceSettings)
Path parameters
serviceId (required)
Path Parameter — format: int32
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
ServiceSettingsInfo
(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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Object
(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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
JobTransferInfo
Up
get /v1/jobs/transfers/{transferId}
(getTransferById)
Path parameters
transferId (required)
Path Parameter — format: uuid
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/jobs/{jobId}/transfers
(getTransfers)
Path parameters
jobId (required)
Path Parameter — format: uuid
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/application.wadl
(getWadl)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.sun.wadl+xml
application/xml
Responses
default
default response
(login)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
LoginResult
(logout)
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
(massDelete)
Query parameters
id (optional)
Query Parameter — format: int64
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
get /v1/performance/memory
(memory)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
MemoryData
Up
get /v1/internals/downloadToken
(newDownloadToken)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Token
(perform)
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
(performAction)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
map[String, Object]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
(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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
AppEventQueryResult
(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
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
JobQueryResult
Up
post /v1/internals/reindex
(reindex)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Object
Up
post /v1/internals/querymode
(setDefaultQueryMode)
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
(setLogLevel)
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the 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 request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
Up
put /v1/configurations/integrations/resource
(update)
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
[ Jump to Methods ]
Table of Contents
ActionInput
AppEvent
AppEventQueryResult
CPUData
ClientSettings
ComponentInfo
DateComponents
DateRange
DiskSpaceData
ENOVIAData
ErrorInfo
FileInfo
IndexStatus
IndexingStats
Job
JobQueryResult
JobTransferInfo
KeyValueMap
Label
LicenseInfo
LogLevelInfo
LoginInput
LoginResult
MemoryData
MemoryPool
NameInfo
PayloadInfo
PayloadInfos
PerformanceInfo
ProductInfo
QueryModeSettings
ReindexInput
ResourceInput
ResourceType
ScheduledJobExecutionInfo
ScheduledJobInfo
SchedulerActionInput
SerieObject
Service
ServiceActivatorInfo
ServiceActivatorInput
ServiceInfo
ServiceSettings
ServiceSettingsInfo
SortField
StatsResult
Token
UpdateInput
id (optional)
eventType (optional)
INFORMATION
WARNING
ERROR
FATAL
time (optional)
description (optional)
details (optional)
data (optional)
data (optional)
totalSize (optional)
page (optional)
pageCount (optional)
version (optional)
id (optional)
displayName (optional)
licenseType (optional)
Full
Trial
Development
Unspecified
expiresIn (optional)
expiracyDate (optional)
year (optional)
quarter (optional)
month (optional)
week (optional)
day (optional)
hour (optional)
minute (optional)
second (optional)
from (optional)
to (optional)
name (optional)
totalSpace (optional)
freeSpace (optional)
unit (optional)
threads (optional)
databaseConnects (optional)
databaseDisconnects (optional)
statefulServerCalls (optional)
statelessServerCalls (optional)
freeTCLInterpretersInPool (optional)
currentlyUsedTCLInterpreters (optional)
memoryHighwater (optional)
memoryAllocated (optional)
memoryReserved (optional)
unit (optional)
sqlstatementsExecuted (optional)
message (optional)
details (optional)
fileName (optional)
displaySize (optional)
size (optional)
lastModified (optional)
url (optional)
jobs (optional)
payloads (optional)
indexedCount (optional)
unindexedCount (optional)
versionMapping (optional)
currentVersion (optional)
id (optional)
status (optional)
INITIALIZED
STARTED
COMPLETED_SUCCESSFULLY
COMPLETED_WITH_ERRORS
PENDING
AWAITING_REPLY
start (optional)
end (optional)
errorMessage (optional)
errorDetails (optional)
service (optional)
resolved (optional)
resolvedDesc (optional)
indexerVersion (optional)
created (optional)
completed (optional)
jobId (optional)
lastIndexed (optional)
execTime (optional)
data (optional)
totalSize (optional)
page (optional)
pageCount (optional)
jobId (optional)
destinationId (optional)
transferred (optional)
started (optional)
completed (optional)
retryAttempt (optional)
responseData (optional)
responseMetaData (optional)
errorMessage (optional)
errorDetails (optional)
transferProperties (optional)
maxRetryAttempts (optional)
empty (optional)
entries (optional)
text (optional)
value (optional)
timestamp (optional)
range (optional)
tif (optional)
tvc (optional)
name (optional)
level (optional)
DEFAULT
OFF
ALL
DEBUG
TRACE
ERROR
INFO
WARNING
username (optional)
password (optional)
freeMemory (optional)
maxMemory (optional)
totalMemory (optional)
collectionCount (optional)
collectionTime (optional)
memoryPools (optional)
timestamp (optional)
unit (optional)
name (optional)
heap (optional)
maxMemory (optional)
usedMemory (optional)
name (optional)
readOnly (optional)
kind (optional)
id (optional)
payloadDataType (optional)
OUTBOUND
INBOUND
contentType (optional)
encoding (optional)
size (optional)
downloadURL (optional)
content (optional)
noDisplayReason (optional)
NO_REASON
BINARY
TOO_LARGE
NOT_AVAILABLE
inbound (optional)
outbound (optional)
time (optional)
cpuData (optional)
diskspaceData (optional)
enoviaData (optional)
memoryData (optional)
reloadDelay (optional)
components (optional)
displayName (optional)
id (optional)
version (optional)
mode (optional)
disabled
index
database
startTime (optional)
endTime (optional)
indexJobs (optional)
indexPayloads (optional)
resourceId (optional)
newResourceId (optional)
overwrite (optional)
data (optional)
name (optional)
kind (optional)
XML
JAVASCRIPT
TEXT
JSON
ANY
readOnly (optional)
aliases (optional)
xsd (optional)
createNewTemplate (optional)
defaultExtension (optional)
id (optional)
start (optional)
end (optional)
errorMessage (optional)
errorDetails (optional)
result (optional)
FAILED
SUCCEEDED
resultMessage (optional)
jobInfo (optional)
id (optional)
groupId (optional)
jobId (optional)
description (optional)
kind (optional)
JOBCFG
MQL
JAVA
SCRIPT
cronExpression (optional)
executions (optional)
lastExecution (optional)
running (optional)
disabled (optional)
groupId (optional)
jobId (optional)
action (optional)
NOOP
PAUSE
RESUME
TRIGGER
status (optional)
INITIALIZED
STARTED
COMPLETED_SUCCESSFULLY
COMPLETED_WITH_ERRORS
PENDING
AWAITING_REPLY
values (optional)
id (optional)
type (optional)
ENOVIA
MESSAGING
AMQP
JMS
MQ
SOAP
REST
FILE
name (optional)
displayName (optional)
configRef (optional)
settings (optional)
id (optional)
description (optional)
running (optional)
stopped (optional)
action (optional)
START
STOP
NOOP
id (optional)
name (optional)
displayName (optional)
configRef (optional)
type (optional)
ENOVIA
MESSAGING
AMQP
JMS
MQ
SOAP
REST
FILE
jobsInProcess (optional)
lastCompleted (optional)
lastError (optional)
totalUsage (optional)
lastCreated (optional)
lastActivity (optional)
serviceId (optional)
logKeepDays (optional)
logPayload (optional)
logPayload (optional)
logKeepDays (optional)
field (optional)
direction (optional)
ASC
DESC
labels (optional)
series (optional)
resolution (optional)
SECOND
SECONDS5
SECONDS15
MINUTE
MINUTES5
MINUTES15
HOUR
HOURS2
DAY
WEEK
MONTH
QUARTER
YEAR
availableResolutions (optional)
dateFormat (optional)
dateComponents (optional)
type (optional)
value (optional)
create (optional)
resolve (optional)
unresolve (optional)
resend (optional)
delete (optional)
abort (optional)