Purge instrument management transaction
post
/service/v1/instrumentManagement/purge
This service related to Purge instrument management transaction.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
Application ID for SMS
-
branchCode(required): string
Branch Code for SMS
-
contentType: string
Content of a file
-
userId(required): string
User ID for SMS
Request Body that contains data required for purging the transaction
Root Schema : ConductorWorkFlowModel
Type:
object
ConductorWorkFlowModel
Show Source
-
amount:
number
Instrument Amount
-
appId:
string
App ID
-
applicationCode:
string
Application Code
-
applicationNumber:
string
Reference number without seqno
-
branchCode:
string
Branch Code
-
businessDate:
string
Business Date
-
cashManagementModel:
object CashManagementModel
CashManagementModel
-
currencyCode:
string
Instrument Currency
-
customerNumber:
string
Customer Id
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
-
event:
string
Event
-
eventCode:
string
eventCode
-
instrumentModel:
object WorkflowInstrumentModel
WorkflowInstrumentModel
-
isReworkAllowed:
string
Rework Allowed Flag
-
priority:
string
To decide the priority of the task
-
processCode:
string
Process Code to identify workflow
-
processingDate:
string
Processing Date
-
processName:
object processName
Process Name to identify workflow
-
product:
string
Product type to identify service for instrument
-
productCategory:
string
Product Category
-
productCode:
string
Product Code
-
screenName:
string
Screen Name
-
stageDescription:
string
Stage desc
-
stageId:
string
Stage Id
-
taskInstanceId:
string
Task Instance Id
-
transactionReferenceNo:
string
Transaction Referenec No
-
uri:
string
Uri
-
userId:
string
User Id
-
workflowInstanceId:
string
Workflow Instance Id
-
workflowType:
string
Workflow Type
Nested Schema : CashManagementModel
Type:
object
CashManagementModel
Show Source
-
additionalDetails:
object additionalDetails
Additional Properties Allowed: additionalPropertiesDetails of other properties
-
channel:
string
Channel
-
countOfDepositSlips:
integer(int64)
Count of Deposit Slips
-
countOfInstruments:
integer(int64)
Count of Instruments
-
instrumentType:
string
Instrument Type
-
isAccEntryGenRequired:
string
Is Acc Entry Gen Reqd flag
-
isArrAndPoolingReqd:
string
isArrAndPoolingReqd flag
-
isAutoAuth:
string
Is Auto Auth flag
-
isClearingRequired:
string
Is Clearing Reqd flag
-
isManualEnrichmentReqd:
string
Is Manual Enrichment Reqd flag
-
isOnlinePostingReqd:
string
Is Online Posting Reqd flag
-
isPoolingRequired:
string
Is Pooling Reqd flag
-
isScheduleGenerationRequired:
string
Is Schedule Generation Reqd flag
-
isUpdateCheckReqd:
string
isUpdateCheckReqd flag
-
operation:
string
Operation
-
productGroup:
string
Product Group
-
referenceNo:
string
Reference No
-
seqNo:
string
Seq No
Nested Schema : WorkflowInstrumentModel
Type:
object
WorkflowInstrumentModel
Show Source
-
action:
string
Action
-
countOfDepositSlips:
integer(int64)
CountOfDepositSlips
-
countOfInstruments:
integer(int64)
CountOfInstruments
-
instrumentType:
string
Instrument Type
-
isAutoAuth:
string
IsAutoAuth
-
isFileAuthorized:
string
isFileUpload
-
isFileUpload:
string
isFileUpload
-
isPortalTxn:
string
isPortalTxn
Nested Schema : processName
Type:
object
Process Name to identify workflow
Nested Schema : additionalDetails
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties
Details of other properties
Nested Schema : additionalProperties
Type:
object
Additional Properties
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Root Schema : ConductorWorkFlowModel
Type:
object
ConductorWorkFlowModel
Show Source
-
amount:
number
Instrument Amount
-
appId:
string
App ID
-
applicationCode:
string
Application Code
-
applicationNumber:
string
Reference number without seqno
-
branchCode:
string
Branch Code
-
businessDate:
string
Business Date
-
cashManagementModel:
object CashManagementModel
CashManagementModel
-
currencyCode:
string
Instrument Currency
-
customerNumber:
string
Customer Id
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
-
event:
string
Event
-
eventCode:
string
eventCode
-
instrumentModel:
object WorkflowInstrumentModel
WorkflowInstrumentModel
-
isReworkAllowed:
string
Rework Allowed Flag
-
priority:
string
To decide the priority of the task
-
processCode:
string
Process Code to identify workflow
-
processingDate:
string
Processing Date
-
processName:
object processName
Process Name to identify workflow
-
product:
string
Product type to identify service for instrument
-
productCategory:
string
Product Category
-
productCode:
string
Product Code
-
screenName:
string
Screen Name
-
stageDescription:
string
Stage desc
-
stageId:
string
Stage Id
-
taskInstanceId:
string
Task Instance Id
-
transactionReferenceNo:
string
Transaction Referenec No
-
uri:
string
Uri
-
userId:
string
User Id
-
workflowInstanceId:
string
Workflow Instance Id
-
workflowType:
string
Workflow Type
Nested Schema : CashManagementModel
Type:
object
CashManagementModel
Show Source
-
additionalDetails:
object additionalDetails
Additional Properties Allowed: additionalPropertiesDetails of other properties
-
channel:
string
Channel
-
countOfDepositSlips:
integer(int64)
Count of Deposit Slips
-
countOfInstruments:
integer(int64)
Count of Instruments
-
instrumentType:
string
Instrument Type
-
isAccEntryGenRequired:
string
Is Acc Entry Gen Reqd flag
-
isArrAndPoolingReqd:
string
isArrAndPoolingReqd flag
-
isAutoAuth:
string
Is Auto Auth flag
-
isClearingRequired:
string
Is Clearing Reqd flag
-
isManualEnrichmentReqd:
string
Is Manual Enrichment Reqd flag
-
isOnlinePostingReqd:
string
Is Online Posting Reqd flag
-
isPoolingRequired:
string
Is Pooling Reqd flag
-
isScheduleGenerationRequired:
string
Is Schedule Generation Reqd flag
-
isUpdateCheckReqd:
string
isUpdateCheckReqd flag
-
operation:
string
Operation
-
productGroup:
string
Product Group
-
referenceNo:
string
Reference No
-
seqNo:
string
Seq No
Nested Schema : WorkflowInstrumentModel
Type:
object
WorkflowInstrumentModel
Show Source
-
action:
string
Action
-
countOfDepositSlips:
integer(int64)
CountOfDepositSlips
-
countOfInstruments:
integer(int64)
CountOfInstruments
-
instrumentType:
string
Instrument Type
-
isAutoAuth:
string
IsAutoAuth
-
isFileAuthorized:
string
isFileUpload
-
isFileUpload:
string
isFileUpload
-
isPortalTxn:
string
isPortalTxn
Nested Schema : processName
Type:
object
Process Name to identify workflow
Nested Schema : additionalDetails
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties
Details of other properties
Nested Schema : additionalProperties
Type:
object
Additional Properties
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error