Operation

post /data/cpb/authenticate
cpbAuthenticate (cpbAuthenticate : /data/cpb/authenticate)
cpbAuthenticate

Request body

Name

IsRequired

Description

Data Type

Enum

body optional httpSession HttpSession ---

Return type
  • DeferredResult«string»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    post /data/cpb/config
    cpbConfiguration (cpbConfiguration : /data/cpb/config)
    cpbConfiguration

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnCpbControllerRequest ---

    Return type
  • DeferredResult«OtnCpbControllerResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnCpbControllerResponse»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    post /data/cpb/deauthenticate
    cpbDeAuthenticate (cpbDeAuthenticate : /data/cpb/deauthenticate)
    cpbDeAuthenticate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • DeferredResult«string»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    post /data/cpb/query
    cpbQuery (cpbQuery : /data/cpb/query)
    cpbQuery

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnCpbControllerRequest ---

    Return type
  • DeferredResult«OtnCpbControllerResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnCpbControllerResponse»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    post /data/cpb/deleteLog
    DeleteLog (deleteLog : /data/cpb/deleteLog)
    DeleteLog

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional cpbLog CpbLogs ---
    body2 optional httpSession HttpSession ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    get /data/cpb/log
    getCPBLog (getCPBLog : /data/cpb/log)
    getCPBLog

    Query parameters

    Name

    IsRequired

    Description

    filename required ---

    Return type
  • ResponseEntity
  • Responses

    Response Messages

    Schema

    200success ResponseEntity
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/html;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/cpb/cpbLogs
    getSavedCPBLogFiles (getSavedCPBLogFiles : /data/cpb/cpbLogs)
    getSavedCPBLogFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • DeferredResult«CpbLogListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«CpbLogListRsp»
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    CpbLogListRsp

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer --- ---
    requestId Long long --- ---
    clientName String string --- ---
    clientLocation String string --- ---
    clientUser String string --- ---
    sessionId String string --- ---
    mdcId String string --- ---
    sequenceNum Integer integer --- ---
    moreToCome Boolean boolean --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    errcde String string --- ---
    errorParams array[Object] object --- ---
    items array[CpbLogs] CpbLogs --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    CpbLogs

    Name

    Type

    Description

    Enum

    className String string --- ---
    id String string --- ---
    key String string --- ---
    commissionFileName String string --- ---
    fileDate String string --- ---
    fileType String string --- ---
    systemName String string --- ---
    outcome String string --- ---
    realFileName String string --- ---

    DeferredResult«CpbLogListRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnConnectionResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnCpbControllerResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«string»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    OtnConnectionResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    messageId String string --- ---
    messageSeverity String string --- ---
    status String string --- ---
    connectionName String string --- ---
    connectionId Integer integer --- ---
    orderNumber String string --- ---
    orderId String string --- ---
    orderStep Integer integer --- ---
    id String string --- ---
    errorField String string --- ---
    errorValue String string --- ---

    OtnCpbControllerCriteria

    Name

    Type

    Description

    Enum

    operator String string --- ---
    name String string --- ---
    value String string --- ---
    expression array[OtnCpbControllerCriteria] OtnCpbControllerCriteria --- ---

    OtnCpbControllerManagedObject

    Name

    Type

    Description

    Enum

    fdn String string --- ---
    classname String string --- ---
    attrs Object object --- ---

    OtnCpbControllerRequest

    Name

    Type

    Description

    Enum

    operation String string --- ---
    classname String string --- ---
    fdn String string --- ---
    managedObjects array[OtnCpbControllerManagedObject] OtnCpbControllerManagedObject --- ---
    criteria OtnCpbControllerCriteria OtnCpbControllerCriteria --- ---

    OtnCpbControllerResponse

    Name

    Type

    Description

    Enum

    responseStatus String string --- ---
    errorMessage String string --- ---
    operation String string --- ---
    classname String string --- ---
    fdn String string --- ---
    managedObjects array[OtnCpbControllerManagedObject] OtnCpbControllerManagedObject --- ---

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageType String string --- [Info, Warning, Error]
    messageUnformatted String string --- ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageId String string --- ---
    messageParams array[String] string --- ---
    messageTime Long long --- ---
    message String string --- ---

    ResponseEntity

    Name

    Type

    Description

    Enum

    headers HttpHeaders HttpHeaders --- ---
    body Object object --- ---
    statusCodeValue Integer integer --- ---
    statusCode String string --- [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511]