REST API for Oracle Banking Collections

Close Task Workflow by Given ID

patch

/api/1.0/taskworkflow/{id}/close

This endpoint is used to close the Task Workflow identified by given ID.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id(required): string

Key of the Task Workflow maintenance.

Header Parameters

appId(required): string

The application ID of host service.
branchCode(required): string

The branch code of requesting branch.
contentType: string

The content type of request or response body.
userId(required): string

The user ID of requesting user.

Request body contain Task Workflow and Modification number of TaskWorkflow maintenance which need to be closed."

Root Schema : KeyDto

Type: object

Key Data transer object

Show Source

modNo: integer

Modification Number
remarks: string

Remarks

{
    "description":"Key Data transer object",
    "type":"object",
    "properties":{
        "modNo":{
            "description":"Modification Number",
            "type":"integer"
        },
        "remarks":{
            "description":"Remarks",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Task Workflow with given ID closed successfully.

Root Schema : ResponseDtoWrapper

Type: object

Response Data Transfer object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

Response Data Transfer object

{
    "type":"object",
    "description":"Response Data Transfer object",
    "properties":{
        "messages":{
            "description":"Messages",
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "description":"Data",
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Response Data Transfer object

Show Source

codes: array codes

Codes
id: string

ID
requestId: string

Request ID
status: string

Status

{
    "description":"Response Data Transfer object",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

Array of: object ResponseCode

Response code

{
    "type":"array",
    "description":"Codes",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Response code

Show Source

arg: string

Argument
args: array args

Arguments
Code: string

Code
Desc: string

Description
Language: string

Language
Type: string

Type

{
    "type":"object",
    "description":"Response code",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Arguments",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"Argument"
        }
    }
}

Nested Schema : args

Type: array

Arguments

Show Source

Array of: object items

{
    "type":"array",
    "description":"Arguments",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error