Jump to

• Request
• Response

Add NLP application details

put

/nlpprocessing-services/service/api/v1/nlpprocessingapplications/nlpapplication

This operation adds NLP application details using NLPProcessingApplication Service.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new NLPApplicationDetails

Root Schema : NLPApplicationDetailsModel

Type: object

NLPApplicationDetails model

Show Source

• applicationBranch: string
  applicationBranch
• applicationChannel: string
  ApplicationChannel
• applicationDate: string
  ApplicationDate
• applicationInitiationDate: string
  applicationInitiationDate
• applicationNumber: string
  Application Number
• businessProductCode: string
  businessProductCode
• docId: string
• docType: string
• facilities: array facilities
  Facility Details
• id: string(int64)
  Id
• keyvals: array keyvals
• lifeCycleCode: string
  LifeCycleCode
• priority: string
  Allowed Values: [ "HIGH", "MEDIUM", "LOW" ]

  TaskPriority
• processRefNumber: string
  process refeernce Number
• remarks: string
  Remarks
• text: string
• transactionHeader: object TransactionHeader
  Transaction Headers
• updatedBy: string
  Updated By

{
    "description":"NLPApplicationDetails model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id",
            "type":"string",
            "format":"int64"
        },
        "docId":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "docType":{
            "type":"string"
        },
        "keyvals":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MltbNerKeyValObjDTO"
            }
        },
        "applicationNumber":{
            "description":"Application Number",
            "type":"string"
        },
        "processRefNumber":{
            "description":"process refeernce Number",
            "type":"string"
        },
        "businessProductCode":{
            "description":"businessProductCode",
            "type":"string"
        },
        "lifeCycleCode":{
            "description":"LifeCycleCode",
            "type":"string"
        },
        "applicationChannel":{
            "description":"ApplicationChannel",
            "type":"string"
        },
        "applicationDate":{
            "description":"ApplicationDate",
            "type":"string"
        },
        "remarks":{
            "description":"Remarks",
            "type":"string"
        },
        "applicationInitiationDate":{
            "description":"applicationInitiationDate",
            "type":"string"
        },
        "applicationBranch":{
            "description":"applicationBranch",
            "type":"string"
        },
        "priority":{
            "description":"priority",
            "$ref":"#/definitions/TaskPriority"
        },
        "transactionHeader":{
            "$ref":"#/definitions/TransactionHeader"
        },
        "facilities":{
            "description":"Facility Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/FacilitiesModel"
            }
        },
        "updatedBy":{
            "description":"Updated By",
            "type":"string"
        }
    }
}

Nested Schema : facilities

Type: array

Facility Details

Show Source

• Array of: object FacilitiesModel
  Facilities Model

{
    "description":"Facility Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/FacilitiesModel"
    }
}

Nested Schema : keyvals

Type: array

Show Source

• Array of: object MltbNerKeyValObjDTO
  tagdetails

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MltbNerKeyValObjDTO"
    }
}

Nested Schema : TransactionHeader

Type: object

Transaction Headers

Show Source

• branchCode: string
  Branch Code
• businessProcessCode: string
  businessProcessCode
• currentUser: string
  Current User
• key1: string
• processCode: string
  Process Code
• processRefNo: string
  Process Ref No
• stage: string
  Stage Code
• taskId: string
• taskOutcome: string
  Branch
• taskPriority: string
  Task Priority
• workflowId: string

{
    "description":"Transaction Headers",
    "type":"object",
    "properties":{
        "processRefNo":{
            "description":"Process Ref No",
            "type":"string"
        },
        "currentUser":{
            "description":"Current User",
            "type":"string"
        },
        "taskPriority":{
            "description":"Task Priority",
            "type":"string"
        },
        "branchCode":{
            "description":"Branch Code",
            "type":"string"
        },
        "taskOutcome":{
            "description":"Branch",
            "type":"string"
        },
        "processCode":{
            "description":"Process Code",
            "type":"string"
        },
        "businessProcessCode":{
            "description":"businessProcessCode",
            "type":"string"
        },
        "stage":{
            "description":"Stage Code",
            "type":"string"
        },
        "key1":{
            "type":"string"
        },
        "workflowId":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        }
    }
}

Nested Schema : FacilitiesModel

Type: object

Facilities Model

Show Source

• availableAmount: number
  Minimum Value: 0

  Available Amount
• facilityAmount: number
  Minimum Value: 0

  Facility Amount
• facilityCurrency: string
  Maximum Length: 4

  Facility Currency
• facilityName: string
  Maximum Length: 35

  Facility Name
• facilityRefNo: string
  Maximum Length: 16

  Facility Reference No
• tranches: array tranches
  Facility Tranches Details

{
    "description":"Facilities Model",
    "type":"object",
    "properties":{
        "facilityRefNo":{
            "description":"Facility Reference No",
            "type":"string",
            "maxLength":"16"
        },
        "facilityName":{
            "description":"Facility Name",
            "type":"string",
            "maxLength":"35"
        },
        "facilityCurrency":{
            "description":"Facility Currency",
            "type":"string",
            "maxLength":"4"
        },
        "facilityAmount":{
            "description":"Facility Amount",
            "type":"number",
            "minimum":"0"
        },
        "availableAmount":{
            "description":"Available Amount",
            "type":"number",
            "minimum":"0"
        },
        "tranches":{
            "description":"Facility Tranches Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/FacilityTranchesModel"
            }
        }
    }
}

Nested Schema : tranches

Type: array

Facility Tranches Details

Show Source

• Array of: object FacilityTranchesModel
  Facility Tranches Model

{
    "description":"Facility Tranches Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/FacilityTranchesModel"
    }
}

Nested Schema : FacilityTranchesModel

Type: object

Facility Tranches Model

Show Source

• availableAmount: number
  Minimum Value: 0

  Available Amount
• trancheAmount: number
  Minimum Value: 0

  Tranche Amount
• trancheCurrency: string
  Maximum Length: 4

  Tranche Currency
• trancheName: string
  Maximum Length: 35

  Tranche Name
• trancheRefNo: string
  Maximum Length: 16

  Tranche Reference No

{
    "description":"Facility Tranches Model",
    "type":"object",
    "properties":{
        "trancheRefNo":{
            "description":"Tranche Reference No",
            "type":"string",
            "maxLength":"16"
        },
        "trancheName":{
            "description":"Tranche Name",
            "type":"string",
            "maxLength":"35"
        },
        "trancheCurrency":{
            "description":"Tranche Currency",
            "type":"string",
            "maxLength":"4"
        },
        "trancheAmount":{
            "description":"Tranche Amount",
            "type":"number",
            "minimum":"0"
        },
        "availableAmount":{
            "description":"Available Amount",
            "type":"number",
            "minimum":"0"
        }
    }
}

Nested Schema : MltbNerKeyValObjDTO

Type: object

tagdetails

Show Source

• annotateTag: string
• displayLabel: string
• end_index: number
• start_index: number
• tagDfltVal: string
• tagDispSeq: number
• tagName: string
• value: string

{
    "description":"tagdetails",
    "type":"object",
    "properties":{
        "tagDispSeq":{
            "type":"number"
        },
        "displayLabel":{
            "type":"string"
        },
        "tagName":{
            "type":"string"
        },
        "annotateTag":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "start_index":{
            "type":"number"
        },
        "end_index":{
            "type":"number"
        },
        "tagDfltVal":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the Id of the newly created NLP application

Headers

• Location: string
  URL of newly created NLP application

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