Jump to

• Request
• Response
• Examples

Get postprocessing substages status details

get

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

Returns the processing status of the postprocess substages.

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 post process sub-stages details

Body ()

Root Schema : PostProcessDetails

Type: object

Show Source

• 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 name of the processing stage.
• stageStatus: string
  The processing status of the stage.
• subLedgerName: string
  The name of the subledger application associated with the uploaded file.
• subStages: array subStages
  The processing details of post processing substages.

{
    "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"
        },
        "subLedgerName":{
            "description":"The name of the subledger application associated with the uploaded file.",
            "type":"string"
        },
        "stageName":{
            "description":"The name of the processing stage.",
            "type":"string"
        },
        "stageStatus":{
            "description":"The processing status of the stage.",
            "type":"string"
        },
        "subStages":{
            "items":{
                "$ref":"#/components/schemas/PostProcessSubStage"
            },
            "description":"The processing details of post processing substages.",
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : subStages

Type: array

The processing details of post processing substages.

Show Source

• Array of: object PostProcessSubStage

{
    "items":{
        "$ref":"#/components/schemas/PostProcessSubStage"
    },
    "description":"The processing details of post processing substages.",
    "type":"array"
}

Nested Schema : PostProcessSubStage

Type: object

Show Source

• error: object PostProcessException
• ledgerName: string
• name: string
• requestId: string
• requestStatus: string
• subStages: array subStages

{
    "properties":{
        "name":{
            "type":"string"
        },
        "ledgerName":{
            "type":"string"
        },
        "requestId":{
            "type":"string"
        },
        "requestStatus":{
            "type":"string"
        },
        "subStages":{
            "items":{
                "$ref":"#/components/schemas/PostProcessSubStage"
            },
            "type":"array"
        },
        "error":{
            "$ref":"#/components/schemas/PostProcessException"
        }
    },
    "type":"object"
}

Nested Schema : PostProcessException

Type: object

Show Source

• exceptionDescription: string
• recommendedActions: array recommendedActions

{
    "properties":{
        "exceptionDescription":{
            "type":"string"
        },
        "recommendedActions":{
            "items":{
                "type":"string"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : subStages

Type: array

Show Source

• Array of: object PostProcessSubStage

{
    "items":{
        "$ref":"#/components/schemas/PostProcessSubStage"
    },
    "type":"array"
}

Nested Schema : recommendedActions

Type: array

Show Source

• Array of: string

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

Back to Top

Examples

You can use this GET REST operation to get details of the processes which were submitted in the postprocessing stage for an Accounting Hub Transaction File along with their corresponding statuses.

Example URL

Here's an example of the resource URL:

GET

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

cURL Command

curl --location 'https://servername.fa.us2.oraclecloud.com/api/erp/integrations/resources/v1/en-us/files/253116158407643136/postProcessDetails?flowName=fah-import' \
--header 'Authorization: Bearer <Bearer token>

Example Response

Here's an example of the response body in JSON format:

{
    "fileId":"98715717449060352",
    "flowName":"fah-import", 
    "subLedgerName": "LOAN",
    "stageName": "Post Process",
    "stageStatus": "Succeeded",
    "subStages": [{
                    "name": "Create Accounting for Data Set",
                    "ledgerName":"US primary",
                    "requestID": "744900",
                    "requestStatus": "Succeeded",
                    "errors": [],
                    "subStages": [
                        {
                            "name": "Create Accounting: Subprocess",
                            "requestID": "744910",
                            "requestStatus": "Succeeded"
                            "errors": [],
                            "SubStages": []
                        },
                        {
                            "name": "Post Subledger Journal Entries",
                            "requestID": "744911",
                            "requestStatus": "Succeeded"
                            "errors": [],
                            "subStages": [
                                {
                                    "name": "Post Subledger Journal Entries: Subprocess",
                                    "requestID": "744912",
                                    "requestStatus": "Succeeded"
                                    "errors": [],
                                    "subStages": []
                                }
                            ],
                        }
                    ],
                }
     ]
}

Back to Top