Steps to Get Error or Record Details via Scribe API

Steps to Get Error or Record Details via Scribe API

book

Article ID: KB0078729

calendar_today

Updated On:

Products Versions
TIBCO Cloud Integration - Connect ( Scribe ) 1

Description

Explanation of Issue

When records are processed by TIBCO Scribe Online and those records have many child entities, if there are row errors during processing, the application may hang when trying the view the error or record details in Execution History. This behavior has been documented in defect 74581.

    Issue/Introduction

    The Scribe application could hang when trying to display Execution History Error Details. Here is a way to get the details by using the Scribe API.

    Resolution

    Steps to Get Error Or Record Details via Scribe API
     

    1. Navigate to api.scribesoft.com.
    2. Input your credentials used to log into TIBCO Scribe Online and select SET.
    3. Scroll down until you reach Solutions and select Show/Hide and select the GET /v1/orgs/{orgid}/solutions, input your orgID and select Try it Out!
    4. In the Response Body find the solution name you would like the record details for and copy the solution Id.
    5. Once you have copied the solution Id, Navigate to the ‘History’ option on the homepage of the API and select Show/Hide and select GET /v1/orgs/{orgId}/solutions/{solutionId}/history. Input the orgID and Solution Idfrom previous step and select Try it Out!
    6. In the Response Body navigate to the execution history record where the errors occurred (most recent records are at the bottom) Once you have found the one that you would like record details for copy the “id” field, which will be the History ID.
    7. Back in the homepage of the API find the “Errors” section and select GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors. Input the orgId, solutionID and historyID from the previous steps.
    8. Select Try it Now! And in the Response Body this is where you will find the error message and error details for this execution history record. If you would also like the payload of the actual records copy the failedRecordID.
    9. Back in the homepage for the API navigate to “FailedRecords” and select show/hide. Navigate to GET /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/failedrecords/{id}. Input the orgID, SolutionID, HistoryID and id (failedrecordID) from the previous steps.
    10. Select Try it Now! In the response body you will now see all of the records/child records that were in this one row error, you can copy this to notepad for better viewing.

    Attachments

    Steps to Get Error or Record Details via Scribe API get_app