History

Use History endpoints to return all Solution execution information for the last 45 days or to mark all errors in an execution for reprocessing. See Viewing Execution History in the TIBCO Scribe® Help.

Other endpoints associated with Execution History include: 

  • FailedRecords — Use FailedRecords endpoints to retrieve information about a specific failed source record from a Solution execution. Use the information to review the source record in the source
  • Errors — Use Errors endpoints to return a list of all errors in Solution execution, a specific error record by error ID, or to mark individual failed source records for reprocessing.

Endpoints— Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.

Fields For History Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Considerations

In some cases there are special considerations or use cases for specific endpoints that you should know about before you use the endpoint.

POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/{id}/reprocess

  • This command is ignored if the Solution is running.

GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export/{exportId}

  • Use the export ID returned by the GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export endpoint to retrieve exported Execution History for a Solution.

Endpoints

Return a list of Solution executions

Return information about a Solution execution

Export Execution History for a Solution execution

Mark all Errors from a Solution execution for reprocessing

Reprocess all marked Errors from a Solution execution

Return statistics for a Solution execution

Fields For History Endpoints

The list of fields defined in this table is comprehensive across all History endpoints. See Endpoints for a list of History endpoints with links to the associated Swagger page.

Name

Description

Endpoints

Parameters

executionHistory
ColumnSort

query

string

Sort Solution executions by one of the following items: 

  • Start — Execution start date and time.
  • Result — Execution result. See result for a list of result types.
  • RecordsProcessed — Number of records processed.
  • RecordsFailed — Number of records failed.

See sortOrder to set ascending or descending record order.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history

exportId

path

integer

ID returned by the GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export method when an export of Execution History for a Solution is requested. Use this ID to retrieve the exported Execution History file using the GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export/{exportId} method. Required

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export/{exportId}

id

path

integer

GUID/UUID of the Solution execution. Required

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/mark
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export/{exportId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/reprocess
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

laterThanDate

query

string

Filter Solution executions by date of execution. Returns executions for the selected date and later. If not set, returns last 45 days of executions.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history

offset

query

integer

Number of executions to skip before returning results. Default value is 0.  

See Reading Resources for more information on offset and limit parameters.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history

orgId

path

integer

Unique ID for each Organization. Required

All

limit

query

integer

Maximum number of executions to return. Default value is 100.

See Reading Resources for more information on offset and limit parameters.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history

mark

query

boolean

Indicates whether to mark or unmark all failed records in this execution for reprocessing. Default is false..

  • true — Mark all failed records in this execution for reprocessing.
  • false — Clear marks for all failed records in this execution. Failed records will not be reprocessed.
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/mark

result

query

string

Filter Solution executions by execution result. Options include: 

  • CompletedSucessfully — No errors and all selected records were processed according to the Solution and Maps.
  • FatalError — An error was encountered that stopped the Solution execution.
  • CompletedWithErrors — Record errors were encountered but the execution completed.
  • InProgress — Solution execution is currently running.
  • RecordErrorsandFatalErrors — Record errors were encountered but the Solution execution stopped due to a Fatal Error.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history

solutionId

path

string

GUID/UUID of the Solution for which you are requesting history. Required

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/mark
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export/{exportId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/reprocess
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

sortOrder

query

string

Sets the order of records when sorted using executionHistoryColumnSort. Default is asc.

  • asc — Sort in ascending order, such as 1,2,3.
  • desc — Sort in descending order, such as 3,2,1.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history

Response

actionType

response

string

Action performed on the object in the legacyCounters array. For example, if the object is a Connection, the actionType is GetConnection. Types include: 

  • Query — Requests entity data.
  • Method — Used with agentProcessing
  • GetConnection — Opens the Connection to the datastore.
  • Operation — Operation performed on an entity, such as Create or Update.
  • Row — Time it takes to loop from record start to record end for a single record.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

averageTime

response

number

Average time in milliseconds for a record in the selected entity to be processed. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

callCount

response

integer

Number times a call was made to a specific object, including: Connections, Entities, Agent Processing, or Operations. Part of the legacyCounters array.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

details

response

string

If the execution fails with a fatal error, a brief description of the problem displays.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

duration

response

number

Number of seconds the execution ran.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

entityName

response

string

Name of the entity being processed in the Map. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

errorCount

response

integer

Number of Method or GetConnection errors. Part of the legacyCounters array.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

errors

response

integer

Number of records that failed. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

exportId

response

string

ID returned by the GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export method when an export of Execution History for a Solution is requested. Use this ID to retrieve the exported Execution History file using the GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export/{exportId} method. Required

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export

id

response

string

GUID/UUID of the Solution record.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

isReprocessJob

response

boolean

  • true — Indicates that this execution was a secondary execution to reprocess failed records.
  • false — Indicates that this was the original execution.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

legacyCounters

response

array

Array of properties containing statistics associated with a single execution of a Solution. Each key value pair contains the GUID/UUID of the statistics record and the ID of the object for which statistics are being gathered. Objects include:

  • Connections — Source or target Connections
  • Entities — Entities from a datastore, such as Contact.
  • Operations — Actions such as Query or Update.

The following properties are included for each object:

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

mapId

response

integer

ID of the Map being processed. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

mapName

response

string

Name of the Map being processed. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

mapStatistics

response

model

Model of the statistics record for a single execution of a Map. Contains the following fields:

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

maxTimeInMs

response

number

Longest time in milliseconds used process either a single call or record in a Map.Used in the of the legacyCounters array and the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

minTimeInMs

response

number

Shortest time in milliseconds used to process either a single call or record in a Map.Used in the of the legacyCounters array and the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

model

response

model

Exported Execution History errors in a comma separated value format for a specific Solution execution. Fields include: 

  • Error Title — Message indicating the type of error that was generated either by TIBCO Scribe® or the Connector, such as Error in calling Operation Create.
  • Error Number — Internal error number. Typically this is 0 because Connectors do not return error numbers.
  • Error Description — Additional details about this error, if available.
  • Timestamp — Date and time that the error occurred.
  • Data — Data within the record that was being processed when the error occurred.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/export/{exportId}

processExecutionId

response

string

Unique identifier for the execution of a Solution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

recordsProcessed

response

integer

Total number of source records processed by this Solution execution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

recordsFailed

response

integer

Total number of source records that failed during this Solution execution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

reprocessRecordsRemaining

response

integer

Number of failed records that are available for reprocessing.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

result

response

string

Indicates whether the execution was successful and if it had errors. See result above for a list of possible result messages.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

rows

response

integer

Number of source records processed by the Map. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

sourceDataLocal

response

boolean

When using TIBCO Scribe® with an On-Premise Agent, you can choose to store record errors either in the cloud or on the computer where the TIBCO Scribe® On-Premise Agent is installed. The default is to store data for record errors in the cloud. See Security Settings in the TIBCO Scribe® Help for additional information.

  • true — Source data is stored locally.
  • false — Source data is stored in the cloud.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

start

response

string

Date and time in UTC that the execution started running.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

stop

response

string

Date and time in UTC the execution stopped running.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}

totalTime

response

number

Total time in milliseconds for all records in the selected entity to be processed. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

totalTimeDisplay

response

string

Total time in hours:minutes:seconds for all records in the selected entity to be processed. Used in the mapStatistics model.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

totalTimeInMs

response

number

Total time in milliseconds to process all calls in the callCount field.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{id}/statistics

 

See

Endpoints

API Basics

Reprocess Failed Records