Initiate task orchestration
post
/web/v1/initiateTransaction
This endpoint is used to initiate the task.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
-
authToken(optional): string
branch code for SMS
-
branchCode: string
-
branchDate(optional): string(date-time)
-
contentType(optional): string
-
tenantId(optional): string
-
userId: string
user id for SMS
Request Body that contains data required for creating a new Finance Transaction
Root Schema : TransactionControllerRequestModel
Type:
Show Source
object
-
referenceNumber(optional):
string
Reference Number
-
tasks(optional):
array tasks
tasks
Nested Schema : EventRequestModel
Type:
object
Event model
Show Source
-
advicesList(optional):
array advicesList
advices list
-
checkList(optional):
array checkList
check list
-
clausesList(optional):
array clausesList
clauses list
-
data(optional):
object ScfScreenClassDetails
Screen class details for given screen class code
-
documentList(optional):
array documentList
document list
Nested Schema : advicesList
Type:
array
advices list
Show Source
-
Array of:
object AdviceModel
Advice model
Nested Schema : checkList
Type:
array
check list
Show Source
-
Array of:
object CheckListModel
CheckList model
Nested Schema : clausesList
Type:
array
clauses list
Show Source
-
Array of:
object ClauseModel
Clause model
Nested Schema : ScfScreenClassDetails
Type:
object
Screen class details for given screen class code
Show Source
-
approverRemarks(optional):
string
-
authStatus(optional):
string
-
checkerId(optional):
string
-
CmcTmScreenDsMappingDTO(optional):
array CmcTmScreenDsMappingDTO
-
doerRemarks(optional):
string
-
domain(optional):
string
-
keyId(optional):
string
-
makerId(optional):
string
-
modNo(optional):
number
-
onceAuth(optional):
string
-
recordStatus(optional):
string
-
screenClassCode(optional):
string
-
screenClassDesc(optional):
string
Nested Schema : documentList
Type:
array
document list
Show Source
-
Array of:
object DocumentModel
Document model
Nested Schema : AdviceModel
Type:
object
Advice model
Show Source
-
adviceGenType(optional):
string
Allowed Values:
[ "INTRA", "EOS" ]
AdviceGenType -
adviceTypeDesc(optional):
string
Minimum Length:
0
Maximum Length:255
adviceTypeDesc -
adviceTypeName:
string
adviceTypeName
-
eventId(optional):
string
Minimum Length:
0
Maximum Length:36
eventId -
status(optional):
string
Allowed Values:
[ "INCOMPLETE", "COMPLETE", "WIP" ]
TransactionControllerModel
Nested Schema : CheckListModel
Type:
object
CheckList model
Show Source
-
checkListData:
string
Minimum Length:
0
Maximum Length:255
checkListData -
checkListId(optional):
string
Minimum Length:
0
Maximum Length:36
checkListId -
eventId(optional):
string
Minimum Length:
0
Maximum Length:36
eventId -
mandatory(optional):
boolean
Default Value:
false
mandatory -
sequenceNo(optional):
string
Minimum Length:
0
Maximum Length:20
sequenceNo -
status(optional):
string
Allowed Values:
[ "INCOMPLETE", "COMPLETE", "WIP" ]
TransactionControllerModel
Nested Schema : ClauseModel
Type:
object
Clause model
Show Source
-
clauseCode:
string
Minimum Length:
0
Maximum Length:20
clauseCode -
clauseDesc(optional):
string
clauseDesc
-
clauseName(optional):
string
Minimum Length:
0
Maximum Length:20
clauseName -
eventId(optional):
string
Minimum Length:
0
Maximum Length:36
eventId -
status(optional):
string
Allowed Values:
[ "INCOMPLETE", "COMPLETE", "WIP" ]
TransactionControllerModel
Nested Schema : CmcTmScreenDsMappingDTO
Type:
Show Source
array
-
Array of:
object CmcTmScreenDsMappingDTO
Data Segment Details
Nested Schema : DocumentModel
Type:
object
Document model
Show Source
-
documentTypeCategory(optional):
string
documentTypeCategory
-
documentTypeDesc(optional):
string
Minimum Length:
0
Maximum Length:255
documentTypeDesc -
documentTypeName:
string
documentTypeName
-
eventId(optional):
string
Minimum Length:
0
Maximum Length:36
eventId -
mandatory(optional):
boolean
Default Value:
false
mandatory -
originalRequired(optional):
string
Minimum Length:
0
Maximum Length:1
originalRequired -
status(optional):
string
Allowed Values:
[ "INCOMPLETE", "COMPLETE", "WIP" ]
TransactionControllerModel -
uploadType(optional):
string
uploadType
-
versioning(optional):
string
Maximum Length:
1
versioning
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
-
Location: string
URL of newly created orchestrator
Root Schema : ScreenClassInitiationDTO
Type:
Show Source
object
-
data(optional):
object ScreenClassResponseDTO
-
messages(optional):
object ResponseDto
ResponseDto stores the response status and code.
Nested Schema : ResponseDto
Type:
object
ResponseDto stores the response status and code.
Show Source
Nested Schema : codes
Type:
Show Source
array
-
Array of:
object ResponseCode
ResponseCode stores the response details.
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