Mark all Errors from a Solution execution for reprocessing
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
Return exported Execution History
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 |
||
query string |
Sort Solution executions by one of the following items:
See sortOrder to set ascending or descending record order. |
|
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 |
|
id path integer |
GUID/UUID of the Solution execution. Required |
|
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. |
|
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. |
|
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. |
|
mark query boolean |
Indicates whether to mark or unmark all failed records in this execution for reprocessing. Default is false..
|
|
query string |
Filter Solution executions by execution result. Options include:
|
|
solutionId path string |
GUID/UUID of the Solution for which you are requesting history. Required |
|
query string |
Sets the order of records when sorted using executionHistoryColumnSort. Default is asc.
|
|
Response |
||
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:
|
|
response number |
Average time in milliseconds for a record in the selected entity to be processed. Used in the mapStatistics model. |
|
response integer |
Number times a call was made to a specific object, including: Connections, Entities, Agent Processing, or Operations. Part of the legacyCounters array. |
|
details response string |
If the execution fails with a fatal error, a brief description of the problem displays. |
|
duration response number |
Number of seconds the execution ran. |
|
response string |
Name of the entity being processed in the Map. Used in the mapStatistics model. |
|
response integer |
Number of Method or GetConnection errors. Part of the legacyCounters array. |
|
response integer |
Number of records that failed. Used in the mapStatistics model. |
|
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 |
|
id response string |
GUID/UUID of the Solution record. |
|
isReprocessJob response boolean |
|
|
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:
The following properties are included for each object: |
|
response integer |
ID of the Map being processed. Used in the mapStatistics model. |
|
response string |
Name of the Map being processed. Used in the mapStatistics model. |
|
response model |
Model of the statistics record for a single execution of a Map. Contains the following fields: |
|
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. |
|
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. |
|
model response model |
Exported Execution History errors in a comma separated value format for a specific Solution execution. Fields include:
|
|
processExecutionId response string |
Unique identifier for the execution of a Solution. |
|
recordsProcessed response integer |
Total number of source records processed by this Solution execution. |
|
recordsFailed response integer |
Total number of source records that failed during this Solution execution. |
|
reprocessRecordsRemaining response integer |
Number of failed records that are available for reprocessing. |
|
result response string |
Indicates whether the execution was successful and if it had errors. See result above for a list of possible result messages. |
|
response integer |
Number of source records processed by the Map. Used in the mapStatistics model. |
|
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.
|
|
start response string |
Date and time in UTC that the execution started running. |
|
stop response string |
Date and time in UTC the execution stopped running. |
|
response number |
Total time in milliseconds for all records in the selected entity to be processed. Used in the mapStatistics model. |
|
response string |
Total time in hours:minutes:seconds for all records in the selected entity to be processed. Used in the mapStatistics model. |
|
response number |
Total time in milliseconds to process all calls in the callCount field. |
|
See