Monitor TIBCO Scribe® Status
The API provides GET methods which can be used to determine the status of your Solutions and Agents. The statuses reported provide information on the health and status of the integration. See the table below for a list of status codes that might be returned from the API.
Use the methods listed below to retrieve the status of an Agent or a Solution.
- Use the GET solution by ID method to retrieve the status of a specific Solution. See the Status Codes — Solutions table.
- Use the GET agent method to retrieve the status of a specific Agent. See the Status Codes — Agents table.
Status Codes — Solutions
For a detailed definition of each status, see the status field in the Solutions reference page.
|
API Status |
Corresponding UI Text |
|---|---|
|
AgentHeartbeatFailed |
Agent heartbeat failed. |
|
AgentHeartbeatLate |
Agent heartbeat late. |
|
AgentShutdown |
Agent shut down. |
|
AgentUpdating |
Agent updating. |
|
Disabled |
Disabled |
|
Idle |
Idle |
|
IdleLastRunFailed |
Idle. Last run failed. |
|
IdleLastRunRowErrors |
Idle. Last run finished with record errors. |
|
Incomplete |
Incomplete |
|
InProgress |
In progress. HH:MM:SS |
|
OnDemand |
Ready to run. |
|
OnDemandLastRunFailed |
Ready to run. Last run failed. |
|
OnDemandLastRunRowErrors |
Ready to run. Last run finished with record errors. |
|
Preparing |
Preparing |
|
ProvisionError |
Provisioning failed. Contact Scribe Support. |
|
Provisioning |
Provisioning |
|
Restarting |
Restarting |
|
Starting |
Running |
|
Stopping |
Stopping |
|
UpdatingConnector |
Updating Connector |
|
WaitingForEvent |
Waiting for Event. |
|
WaitingToRestartAgentMemoryLimit |
Waiting to restart, memory limit reached. |
|
WaitintToRestartAgentUserRequest |
Waiting to restart, user requested. |
|
WaitingToUpdateAgent |
Waiting to update Agent. |
|
WaitingToUpdateConnector |
Waiting to update Connector. |
Status Codes — Agents
For a detailed definition of each status, see the status field in the Agents reference page.
|
API Status |
Corresponding UI Text |
|---|---|
|
AgentUpdating |
Agent Updating |
|
HeartbeatFailed |
Heartbeat Failed |
|
Heartbeatlate |
Heartbeat Late |
|
Restarting |
Restarting |
|
Running |
Running |
|
Shutdown |
Shutdown |
|
ShutdownCloud |
Shutdown Cloud |
|
Unknown |
Unknown |
|
UpdatingConnector |
Updating Connector |
|
WaitingToRestartAgentMemoryLimit |
Waiting to restart, memory limit reached. |
|
WaitintToRestartAgentUserRequest |
Waiting to restart, user requested. |
|
WaitingToUpdateAgent |
Waiting to Update Agent. |
|
WaitingToUpdateConnector |
Waiting to Update Connector. |
See