Operation

post /data/cpb/authenticate
authenticat CPB APP (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
    execute CPB Config Request (cpbConfiguration : /data/cpb/config)
    cpbConfiguration

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req CpbDriverRequest ---

    Return type
  • DeferredResult«CpbDriverRequest»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«CpbDriverRequest»
    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
    de-authenticat CPB APP (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
    execute CPB Query Request (cpbQuery : /data/cpb/query)
    cpbQuery

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req CpbDriverRequest ---

    Return type
  • DeferredResult«CpbDriverRequest»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«CpbDriverRequest»
    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
    delete specified CPB log file (deleteLog : /data/cpb/deleteLog)
    DeleteLog

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«Otn connection Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«Otn connection Response»
    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
    get specified CPB log file (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
    retrieve all CPB logs saved on host (getSavedCPBLogFiles : /data/cpb/cpbLogs)
    getSavedCPBLogFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • DeferredResult«WDM Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«WDM Response»
    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 :

    CpbDriverManagedObject

    Name

    Type

    Description

    Enum

    fdn String string --- ---
    expression array[CpbDriverManagedObject] CpbDriverManagedObject --- ---
    classname String string --- ---
    name String string --- ---
    value String string --- ---
    operator String string --- ---
    attrs Object object --- ---

    CpbDriverRequest

    Name

    Type

    Description

    Enum

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

    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«CpbDriverRequest»

    Name

    Type

    Description

    Enum

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

    DeferredResult«Otn connection Response»

    Name

    Type

    Description

    Enum

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

    DeferredResult«string»

    Name

    Type

    Description

    Enum

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

    DeferredResult«WDM Response»

    Name

    Type

    Description

    Enum

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

    Otn connection Response

    Name

    Type

    Description

    Enum

    message String string Message ( localized message) ---
    messageId String string Message Id (ID of the localized message) ---
    messageSeverity String string Message Severity (will be empty when status is success and E when there is a failure) ---
    status String string Status [SUCCESS, FAILURE, IN_PROGRESS]
    connectionName String string Connection Name ---
    connectionId Integer integer Connection Id (Here Connection Id represents the group Id) ---
    orderNumber String string Order Number (number prefixed by the ordertype like A for Add,D for delete, DV for Discovered, VD for DbDelete,R for Rearrange, RR for Rearrange with reinstate etcThese ordertype shall be prefixed with additional I if it is integrated operations) ---
    orderId String string Order Id ( unique number generated by sequence) ---
    orderStep Integer integer Order Step ---
    id String string Request Id (Identifier of the request) ---
    errorField String string Error Field ( shall be the name of the incorrect attribute) ---
    errorValue String string Error Value ( shall be the value of the incorrect attribute) ---

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageUnformatted String string Message Unformatted ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageType String string Message Type [Info, Warning, Error]
    messageId String string Message Id ---
    messageParams array[String] string Message Params ---
    messageTime Long long Message Time ---
    message String string Message ---

    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]

    WDM Response

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    items array[CpbLogs] CpbLogs --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---