Jump to

• Request
• Response

Get exception details for a file

get

/api/erp/integrations/resources/v1/{locale}/files/{id}/transactionExceptions

Returns a summary of exceptions encountered during the transaction stage for a specific file.

Request

Path Parameters

• id(required): string
  The unique identifier of the file.

  Example:

  324108415901929470

• locale(required): string
  The locale to which the file is being uploaded.

  Example:

  en-us

Query Parameters

• flowName: string
  The name of the flow for which the service is being invoked.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Simple JSON containing exception details for transaction stage

Body ()

Root Schema : ExceptionDetails

Type: object

Show Source

• exceptions: array exceptions
  The exception details for a specific file.
• fileId: string
  The unique identifier of the file.
• flowName: string
  The name of the flow for which the service is being invoked.
• stageName: string
  The file processing stage in which the exceptions were encountered.

{
    "properties":{
        "fileId":{
            "description":"The unique identifier of the file.",
            "type":"string"
        },
        "flowName":{
            "description":"The name of the flow for which the service is being invoked.",
            "type":"string"
        },
        "stageName":{
            "description":"The file processing stage in which the exceptions were encountered.",
            "type":"string"
        },
        "exceptions":{
            "items":{
                "$ref":"#/components/schemas/ImportException"
            },
            "description":"The exception details for a specific file.",
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : exceptions

Type: array

The exception details for a specific file.

Show Source

• Array of: object ImportException

{
    "items":{
        "$ref":"#/components/schemas/ImportException"
    },
    "description":"The exception details for a specific file.",
    "type":"array"
}

Nested Schema : ImportException

Type: object

Show Source

• count: integer (int64)
• exceptionDescription: string
• exceptionType: string
• recommendedActions: array recommendedActions

{
    "properties":{
        "exceptionType":{
            "type":"string"
        },
        "count":{
            "format":"int64",
            "type":"integer"
        },
        "exceptionDescription":{
            "type":"string"
        },
        "recommendedActions":{
            "items":{
                "type":"string"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : recommendedActions

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Back to Top