FailedRecords

Use the FailedRecords endpoint to view information about a specific failed source record that generated an error during Solution execution. Use the specific record information to access that record in your source data and make any necessary corrections. If the problem does not reside in the source data itself, use the Errors endpoints to locate and review the details associated with the failed record to resolve the underlying issue, such as, a mismatched data type, too many matches for matching criteria, or a required missing field that was not included in your Maps. 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.
• 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 FailedRecords 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.

GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}

• Failed source records can only be retrieved if the IsSourceDataLocal property in the Organization model is false, which allows source data to be stored in the cloud. Use the Get errors call to find the ID of the error. See Errors for more information on retrieving error records and Security Settings in the TIBCO Scribe® Help.

Endpoints

Fields For FailedRecords Endpoints

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

Name Type Data Type	Description	Endpoints
Parameters
historyId path integer	GUID/UUID of the Solution execution for which you are requesting errors. Required	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}
id path string	GUID/UUID of the single source record with the error. Required	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}
orgId path integer	Unique ID for each Organization. Required	All
solutionId path string	GUID/UUID of the Solution for which you are requesting failed records. Required	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}
Response
children response array	Array of Key Value pairs containing the source record child data, such as id, or name. For example, if the source record is a Contact record, then the child records could be one or more Addresses for that Contact.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}
id response string	GUID/UUID of the error record for a single source record.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}
name response string	Name of the entity for the source record, such as Contact or Address. Contained within the sourceData model.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}
properties response array	Array of Key Value pairs containing the source record data, such as id, or name.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}
sourceData response string	Model for the source record.	GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}

 

See

Endpoints

API Basics

Reprocess Failed Records