Rest API for Oracle Banking Liquidity Management Cloud Service

Retrieves the Structure by ID

get

/sweepservice/adhoc/{id}

This endpoint is used to get the structure by ID.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id(required): string

Id of the structure that needs to be fetched

Query Parameters

version: string

version of the structure that needs to be fetched

Response

Supported Media Types

application/json
application/xml

200 Response

Returns the structure based on given id.

Root Schema : LmsTbAdhocStrSweepDTO

Type: object

Match All

Show Source

allOf GenericDto
object LmsTbAdhocStrSweepDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "structureDescription":{
                    "type":"string",
                    "description":""
                },
                "structureMasterId":{
                    "type":"string",
                    "description":""
                },
                "versionNo":{
                    "type":"integer",
                    "description":""
                },
                "effectiveDate":{
                    "type":"string",
                    "description":""
                },
                "overRidePendingSweep":{
                    "type":"string",
                    "description":""
                },
                "includeExternalAccount":{
                    "type":"string",
                    "description":""
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":""
                },
                "executionType":{
                    "type":"string",
                    "description":""
                },
                "status":{
                    "type":"string",
                    "description":""
                },
                "sweepStatus":{
                    "type":"string",
                    "description":""
                },
                "sweepId":{
                    "type":"string",
                    "description":""
                },
                "headerBranchCode":{
                    "type":"string",
                    "description":""
                },
                "LmsTbAdhocAccpairSweepDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmsTbAdhocAccpairSweepDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]

Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmsTbAdhocStrSweepDTO-allOf[1]

Type: object

Show Source

customerId: string

Pattern: [a-zA-Z0-9]{1,20}
customerName: string
effectiveDate: string
executionType: string
headerBranchCode: string
includeExternalAccount: string
LmsTbAdhocAccpairSweepDTO: array LmsTbAdhocAccpairSweepDTO
overRidePendingSweep: string
status: string
structureDescription: string
structureId: string

Pattern: [A-Z0-9]{1,30}
structureMasterId: string
sweepId: string
sweepStatus: string
versionNo: integer

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDescription":{
            "type":"string",
            "description":""
        },
        "structureMasterId":{
            "type":"string",
            "description":""
        },
        "versionNo":{
            "type":"integer",
            "description":""
        },
        "effectiveDate":{
            "type":"string",
            "description":""
        },
        "overRidePendingSweep":{
            "type":"string",
            "description":""
        },
        "includeExternalAccount":{
            "type":"string",
            "description":""
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":""
        },
        "executionType":{
            "type":"string",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "sweepStatus":{
            "type":"string",
            "description":""
        },
        "sweepId":{
            "type":"string",
            "description":""
        },
        "headerBranchCode":{
            "type":"string",
            "description":""
        },
        "LmsTbAdhocAccpairSweepDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmsTbAdhocAccpairSweepDTO"
            }
        }
    }
}

Nested Schema : LmsTbAdhocAccpairSweepDTO

Type: array

Show Source

Array of: object LmsTbAdhocAccpairSweepDTO

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

Nested Schema : LmsTbAdhocAccpairSweepDTO

Type: object

Show Source

accountNumber: string
adhocSweepStrMasterId: string
branchCode: string
currencyCode: string
id: string
instructionId: string
instructionPriority: string
parentAccountBranch: string
parentAccountCurrency: string
parentAccountNumber: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "adhocSweepStrMasterId":{
            "type":"string",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "instructionId":{
            "type":"string",
            "description":""
        },
        "instructionPriority":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "currencyCode":{
            "type":"string",
            "description":""
        },
        "parentAccountNumber":{
            "type":"string",
            "description":""
        },
        "parentAccountBranch":{
            "type":"string",
            "description":""
        },
        "parentAccountCurrency":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error