Jump to

• Request
• Response

Get a file status and metric details

get

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

Returns the processing status and current 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.

Header Parameters

• userType:
  For internal use only.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Simple JSON containing progress status and transaction count by file

Body ()

Root Schema : InboundFile

Type: object

Show Source

• currentStage: string
  Indicates the current stage.
• dateFormatUsed: string
  The date format specified for the uploaded file.
• elapsedTime: string
  The time elapsed since the file was uploaded for processing.
• fileId: string
  The unique identifier of the file.
• flowName: string
  The name of the flow for which the service is being invoked.
• lastStatusTime: string
  The time when the status was last fetched.
• stages: object StageChild
• status: string
  The overall processing status of the uploaded file.
• uploadedBy: string
  The user who uploaded the file.
• uploadedTime: string
  The date and time when the file was uploaded.

{
    "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"
        },
        "status":{
            "description":"The overall processing status of the uploaded file.",
            "type":"string"
        },
        "dateFormatUsed":{
            "description":"The date format specified for the uploaded file.",
            "type":"string"
        },
        "uploadedTime":{
            "description":"The date and time when the file was uploaded.",
            "type":"string"
        },
        "uploadedBy":{
            "description":"The user who uploaded the file.",
            "type":"string"
        },
        "lastStatusTime":{
            "description":"The time when the status was last fetched.",
            "type":"string"
        },
        "elapsedTime":{
            "description":"The time elapsed since the file was uploaded for processing.",
            "type":"string"
        },
        "currentStage":{
            "description":"Indicates the current stage.",
            "type":"string"
        },
        "stages":{
            "description":"The progress details of each processing stage.",
            "$ref":"#/components/schemas/StageChild"
        }
    },
    "type":"object"
}

Nested Schema : StageChild

Type: object

Show Source

• consolidation: object FileStage
• enrich: object FileStage
• holding: object FileStage
• inboundData: object InboundDataStage
• postprocess: object PostProcessStage
• processTask: object PostProcessStage
• transaction: object ImportTransactionStage
• upload: object FileStage
• validation: object FileStage

{
    "properties":{
        "upload":{
            "$ref":"#/components/schemas/FileStage"
        },
        "validation":{
            "$ref":"#/components/schemas/FileStage"
        },
        "holding":{
            "$ref":"#/components/schemas/FileStage"
        },
        "consolidation":{
            "$ref":"#/components/schemas/FileStage"
        },
        "enrich":{
            "$ref":"#/components/schemas/FileStage"
        },
        "inboundData":{
            "$ref":"#/components/schemas/InboundDataStage"
        },
        "transaction":{
            "$ref":"#/components/schemas/ImportTransactionStage"
        },
        "postprocess":{
            "$ref":"#/components/schemas/PostProcessStage"
        },
        "processTask":{
            "$ref":"#/components/schemas/PostProcessStage"
        }
    },
    "type":"object"
}

Nested Schema : FileStage

Type: object

Show Source

• elapsedTime: string
• endTime: string
• errors: string
• exceptions: object ValidationException
• name: string
• startTime: string
• status: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "elapsedTime":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "errors":{
            "type":"string"
        },
        "exceptions":{
            "$ref":"#/components/schemas/ValidationException"
        }
    },
    "type":"object"
}

Nested Schema : InboundDataStage

Type: object

Show Source

• elapsedTime: string
• endTime: string
• errors: string
• exceptions: object ValidationException
• name: string
• startTime: string
• status: string
• subStages: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "elapsedTime":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "subStages":{
            "type":"string"
        },
        "errors":{
            "type":"string"
        },
        "exceptions":{
            "$ref":"#/components/schemas/ValidationException"
        }
    },
    "type":"object"
}

Nested Schema : PostProcessStage

Type: object

Show Source

• elapsedTime: string
• endTime: string
• errors: string
• exceptions: string
• name: string
• startTime: string
• status: string
• subStages: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "elapsedTime":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "subStages":{
            "type":"string"
        },
        "errors":{
            "type":"string"
        },
        "exceptions":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : ImportTransactionStage

Type: object

Show Source

• dataflowStartUpTIme: string
• elapsedTime: string
• endTime: string
• errorHeaderCount: integer (int64)
• errorLineCount: integer (int64)
• errors: string
• exceptions: string
• name: string
• processInitStartTime: string
• sparkJobTime: string
• startTime: string
• status: string
• successHeaderCount: integer (int64)
• successLineCount: integer (int64)
• totalHeaderCount: integer (int64)
• totalLineCount: integer (int64)

{
    "properties":{
        "name":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "elapsedTime":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "totalHeaderCount":{
            "format":"int64",
            "type":"integer"
        },
        "successHeaderCount":{
            "format":"int64",
            "type":"integer"
        },
        "errorHeaderCount":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineCount":{
            "format":"int64",
            "type":"integer"
        },
        "successLineCount":{
            "format":"int64",
            "type":"integer"
        },
        "errorLineCount":{
            "format":"int64",
            "type":"integer"
        },
        "errors":{
            "type":"string"
        },
        "exceptions":{
            "type":"string"
        },
        "sparkJobTime":{
            "type":"string"
        },
        "processInitStartTime":{
            "type":"string"
        },
        "dataflowStartUpTIme":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : ValidationException

Type: object

Show Source

• errorDescription: string
• recommendedActions: array recommendedActions

{
    "properties":{
        "errorDescription":{
            "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