REST API for Oracle Banking Collections

Update Task Status and Followup Date

put

/api/1.0/taskWorkFlow/updateTaskStatusAndFollowUpDate

This endpoint is used to update task status and followup date for a single task ID or only update followup date for tasks belonging to a particular account based on segment code and strategy code.

Request

Supported Media Types

application/json
application/xml

Query Parameters

applyToAllInitiatedTask(required): string

Apply to all initiated task flag.

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 data required for updating an existing Task.

Root Schema : DmTmTaskVO

Type: object

Task Data List

Show Source

accountId: string

Account ID
addlAttributes: object AdditionalAttributesDto

Additional Attributes
adhocFlag: string

Adhoc Flag
assignedTo: string

Assigned To
dependency: string

Dependency
escalationDate: string

Escalation Date
expiryDate: string

Expiry Date
followupDate: string

FollowUp Date
newlyCreatedAdhocTask: boolean

Newly Created Adhoc Tasks
notes: string

Notes
segmentCode: string

Segment Code
segmentDescription: string

Segment Description
sequence: integer

Sequence
startDate: string

Start Date
strategyCode: string

Strategy Code
strategyDescription: string

Strategy Description
taskId: string

Task ID
taskInProgress: boolean

Task In Progress
taskName: string

Task Name
taskNameDescription: string

Task Name Description
taskStatusCode: string

Task Status Code
taskType: string

Task Type
taskTypeCode: string

Task type Code

{
    "description":"Task Data List",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "segmentCode":{
            "description":"Segment Code",
            "type":"string"
        },
        "strategyCode":{
            "description":"Strategy Code",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID",
            "type":"string"
        },
        "taskType":{
            "description":"Task Type",
            "type":"string"
        },
        "sequence":{
            "description":"Sequence",
            "type":"integer"
        },
        "taskName":{
            "description":"Task Name",
            "type":"string"
        },
        "startDate":{
            "description":"Start Date",
            "type":"string"
        },
        "followupDate":{
            "description":"FollowUp Date",
            "type":"string"
        },
        "escalationDate":{
            "description":"Escalation Date",
            "type":"string"
        },
        "expiryDate":{
            "description":"Expiry Date",
            "type":"string"
        },
        "dependency":{
            "description":"Dependency",
            "type":"string"
        },
        "addlAttributes":{
            "$ref":"#/definitions/AdditionalAttributesDto",
            "description":"Additional Attributes"
        },
        "notes":{
            "description":"Notes",
            "type":"string"
        },
        "taskStatusCode":{
            "description":"Task Status Code",
            "type":"string"
        },
        "assignedTo":{
            "description":"Assigned To",
            "type":"string"
        },
        "taskInProgress":{
            "description":"Task In Progress",
            "type":"boolean"
        },
        "strategyDescription":{
            "description":"Strategy Description",
            "type":"string"
        },
        "segmentDescription":{
            "description":"Segment Description",
            "type":"string"
        },
        "taskNameDescription":{
            "description":"Task Name Description",
            "type":"string"
        },
        "taskTypeCode":{
            "description":"Task type Code",
            "type":"string"
        },
        "newlyCreatedAdhocTask":{
            "description":"Newly Created Adhoc Tasks",
            "type":"boolean"
        },
        "adhocFlag":{
            "description":"Adhoc Flag",
            "type":"string"
        }
    }
}

Nested Schema : AdditionalAttributesDto

Type: object

Additional Attributes

Show Source

applicationId: string

Application ID
dataReferenceKey: string

Data reference key
fieldData: string

Field Data
fieldMetaDataVersion: string

Field Meta Data Version
historyRemarks: string

History Remarks
historyRequired: string

History Required
id: string

ID
uiKey: string

UI Key

{
    "description":"Additional Attributes",
    "properties":{
        "applicationId":{
            "description":"Application ID",
            "type":"string"
        },
        "dataReferenceKey":{
            "description":"Data reference key",
            "type":"string"
        },
        "fieldData":{
            "description":"Field Data",
            "type":"string"
        },
        "fieldMetaDataVersion":{
            "description":"Field Meta Data Version",
            "type":"string"
        },
        "historyRemarks":{
            "description":"History Remarks",
            "type":"string"
        },
        "historyRequired":{
            "description":"History Required",
            "type":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "uiKey":{
            "description":"UI Key",
            "type":"string"
        }
    },
    "type":"object"
}

Response

Supported Media Types

application/json
application/xml

201 Response

Return message of success or failure of the task status and follow up date update.

Headers

Location: string

URL of newly updated task.

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.

405 Response

Invalid input.

500 Response

Internal error.