Jump to

• Request
• Response

Initiate a new allocation transaction

post

/service/v1/postAllocation

This endpoint initiates a new allocation transaction.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  App Id
• branchCode(required): string
  Branch Code
• userId(required): string
  User Id

Body ()

Request Body that contains data required for initiating a new txn

Root Schema : ConductorWorkFlowModel

Type: object

ConductorWorkFlowModel

Show Source

• appId: string
  Application id
• applicationCode: string
  Application code
• applicationNumber: string
  Application Number
• branchCode: string
• businessDate: string
  Business Date
• errorCode: string
  Error Code
• errorDesc: string
  Error Desc
• event: string
  Event
• isInProgKafkaTaskReqd: string
  isInProgKafkaTaskReqd
• priority: string
  Priority
• processCode: string
  Process Code to identify workflow
• processingDate: string
  Processing Date
• processName: object processName
  Process Name to identify workflow
• product: string
  Product
• productCategory: string
  Product Category
• productCode: string
  Product Code
• server: string
  server
• 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

{
    "description":"ConductorWorkFlowModel",
    "type":"object",
    "properties":{
        "processCode":{
            "type":"string",
            "description":"Process Code to identify workflow"
        },
        "processName":{
            "type":"object",
            "description":"Process Name to identify workflow"
        },
        "userId":{
            "type":"string",
            "description":"User Id"
        },
        "stageId":{
            "type":"string",
            "description":"Stage Id"
        },
        "stageDescription":{
            "type":"string",
            "description":"Stage desc"
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        },
        "transactionReferenceNo":{
            "type":"string",
            "description":"Transaction Referenec No"
        },
        "processingDate":{
            "description":"Processing Date",
            "type":"string"
        },
        "businessDate":{
            "description":"Business Date",
            "type":"string"
        },
        "workflowInstanceId":{
            "description":"Workflow Instance Id",
            "type":"string"
        },
        "taskInstanceId":{
            "description":"Task Instance Id",
            "type":"string"
        },
        "applicationCode":{
            "description":"Application code",
            "type":"string"
        },
        "workflowType":{
            "description":"Workflow Type",
            "type":"string"
        },
        "productCode":{
            "description":"Product Code",
            "type":"string"
        },
        "event":{
            "description":"Event",
            "type":"string"
        },
        "productCategory":{
            "description":"Product Category",
            "type":"string"
        },
        "appId":{
            "description":"Application id",
            "type":"string"
        },
        "uri":{
            "description":"URI",
            "type":"string"
        },
        "applicationNumber":{
            "description":"Application Number",
            "type":"string"
        },
        "priority":{
            "description":"Priority",
            "type":"string"
        },
        "product":{
            "description":"Product",
            "type":"string"
        },
        "server":{
            "description":"server",
            "type":"string"
        },
        "isInProgKafkaTaskReqd":{
            "type":"string",
            "description":"isInProgKafkaTaskReqd"
        }
    }
}

Nested Schema : processName

Type: object

Process Name to identify workflow

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Body ()

Root Schema : ConductorWorkflowModel

Type: object

ConductorWorkflowModel

Show Source

• errorCode: string
  Error Code
• errorDesc: string
  Error Desc
• transactionReferenceNo: string
  Transaction Referenec No

{
    "description":"ConductorWorkflowModel",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        },
        "transactionReferenceNo":{
            "type":"string",
            "description":"Transaction Referenec No"
        }
    }
}

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

Back to Top