Operation
post /data/cpb/authenticateOTN service requesting that CPB accept the very next /Cpb HTTP (seesion) request an authenticated user (cpbAuthenticate : /data/cpb/authenticate)
This service to eventually be replaced with CAS authentication support
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
Return type
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/configCPB test driver service for executing CPB a configuration commands, equivalent to those performed on the Aurora interface from CPB Web App (cpbConfiguration : /data/cpb/config)
See the cpb.services.log for the JSON string for individual config commands
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | CpbDriverRequest |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
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/deauthenticateOTN service requesting that CPB remove the /Cpb HTTP seesion associated with this OTN user (cpbDeAuthenticate : /data/cpb/deauthenticate)
This service to eventually be replaced with CAS authentication support
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
Return type
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/queryCPB test driver service for executing CPB query commands, equivalent to those performed on the Aurora interface from CPB Web App (cpbQuery : /data/cpb/query)
See the cpb.services.log for the JSON string for individual queries
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | CpbDriverRequest |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
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/deleteLogOTN service requesting the deletion of a specific CPB log file name, stored on the OTN server. (deleteLog : /data/cpb/deleteLog)
DeleteLog
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | cpbLog | CpbLogs |
--- |
| body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
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/logOTN service retrieving the contents of the requested CPB log files (getCPBLog : /data/cpb/log)
getCPBLog
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| filename | required | filename to display |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
Otn connection 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.
text/html;charset=UTF-8
External Docs
See Also :
Operation
get /data/cpb/cpbLogsOTN service requesting the list of CPB log names stored on the OTN server. (getSavedCPBLogFiles : /data/cpb/cpbLogs)
getSavedCPBLogFiles
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
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 |
|---|---|---|---|
| operator | String string |
--- | --- |
| name | String string |
--- | --- |
| value | String string |
--- | --- |
| expression | array[CpbDriverManagedObject] CpbDriverManagedObject |
--- | --- |
CpbDriverRequest
Name |
Type |
Description |
Enum |
|---|---|---|---|
| operation | String string |
--- | --- |
| classname | String string |
--- | --- |
| fdn | String string |
--- | --- |
| managedObjects | array[CpbDriverManagedObject] CpbDriverManagedObject |
--- | --- |
| criteria | CpbDriverManagedObject CpbDriverManagedObject |
--- | --- |
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 |
--- | --- |
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) | --- |
| pollForJobStatus_suggestedPollingIntervalInSec | Integer integer |
--- | --- |
| pollForJobStatus_suggestedOperationTimeoutInSec | Integer integer |
--- | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
|---|---|---|---|
| messageTime | Long long |
Message Time | --- |
| messageType | String string |
Message Type | [Info, Warning, Error] |
| messageUnformatted | String string |
Message Unformatted | --- |
| validPropertyResourceMessage | Boolean boolean |
--- | --- |
| messageId | String string |
Message Id | --- |
| messageParams | array[String] string |
Message Params | --- |
| message | String string |
Message | --- |
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 | --- |