Errors

Use the Errors endpoints to view information about errors associated with a Solution execution, locate specific errors, and mark individual source records for reprocessing. See Managing Failed IS Or MS Execution History Records or Managing Failed RS Execution History Records in the TIBCO Scribe® Help for additional information. Other endpoints associated with Execution History include:

History — Use History endpoints to return all Solution execution information for the last 45 days, regardless of whether there are errors or not, or to mark all errors in an execution for reprocessing. See Viewing Execution History in the TIBCO Scribe® Help.
FailedRecords — Use FailedRecords endpoints to retrieve information about a specific failed source record from a Solution execution.

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 Errors Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Endpoints

/v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors

Return a list of Errors from a Solution execution

/v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors{id}

Return information about an Error from a Solution execution

/v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}/mark

Mark an Error from a Solution execution for reprocessing

Fields For Errors Endpoints

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

Name Type Data Type	Description	Endpoints
Parameters
historyId path integer	ID of the Solution execution for which you are requesting errors. Required	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}/mark GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
historyId path string	ID of the Solution execution for which you are requesting errors. Required	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
id path string	GUID/UUID of the error record for a single error.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id} POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}/mark
limit query integer	Maximum number of errors to return. Default value is 100. See Reading Resources for more information on offset and limit parameters.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors
mark query boolean	Indicates whether the canReprocess flag should be set or cleared for all failed records. Default is true. true — Set reprocess flag to true. false — Clear reprocess flag.	POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}/mark
offset query integer	Number of errors 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/{historyId}/errors
orgId path integer	Unique ID for each Organization. Required	All
solutionId path string	GUID/UUID of the Solution for which you are requesting errors. Required	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id} POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}/mark
Response
additionalErrorDetails response string	Any additional details about the error that are returned from either the Connector or the data source.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
canReprocess response boolean	Indicates whether or not the record can be reprocessed. Default is true. Each record error can only be reprocessed once .When an error is reprocessed, this flag is set to false. Only those records with a value of true can be marked by the POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}/mark. See mark. true — Record can be marked for reprocessing. false — Record cannot be marked for reprocessing.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
errorDetail response string	Details for the error returned from either TIBCO Scribe® or the Connector for the data source. Details might include information about the attempted operation, the name of the Entity, lookup and match criteria, or batch processing.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
errorMessage response string	Error message produced by either TIBCO Scribe® or the Connector for the data source.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
failedRecordId response string	GUID/UUID of the source record with errors.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
id response string	GUID/UUID of the error record for a single error.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
mapName response string	Map in which the error occurred.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}
marked response boolean	Indicates whether or not the record has been marked to be reprocessed. true — Marked for reprocessing. false — Not marked for reprocessing.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors
sourceEntity response string	Source entity for which the error occurred.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}

See

Endpoints

API Basics

Reprocess Failed Records