Provide Controllable Device Status Check
post
https://server:port/rest/apis/cross/digitalAssets/controllableDeviceStatus/response
This REST web service provides the controllable device's communication status. It is the asynchronous counterpart to the Controllable Device - Device Status Check request. When a device communication status check request is received, this REST web service can be used to provide the controllable device's communication status in response to that request.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail
Type:
Show Source
object
-
result: object
POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result
-
transactionID: string
Maximum Length:
30
The unique identifier used to determine the initiating controllable device communication status check transaction.
Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result
Type:
Show Source
object
-
status: string
Allowed Values:
[ "SUCCESS", "FAILURE" ]
The status code of the controllable device communication status check result.: * `SUCCESS` - Success, * `FAILURE` - Failure
Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail
Type:
Show Source
object
-
result: object
POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result
-
transactionID: string
Maximum Length:
30
The unique identifier used to determine the initiating controllable device communication status check transaction.
Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result
Type:
Show Source
object
-
status: string
Allowed Values:
[ "SUCCESS", "FAILURE" ]
The status code of the controllable device communication status check result.: * `SUCCESS` - Success, * `FAILURE` - Failure
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1-CDStsChkR
Type:
Show Source
object
-
boStatus: string
Maximum Length:
12
Status of the controllable device communication request based on business object lifecycle. The controllable device communication status check transitions through different statuses in its lifecycle. On creation, the status uses a default of PENDING and then transitions to VALIDATE. On successful validation, it enters awaiting response status monitoring status AWAITRESP. If no response is received within the configured limit it goes to response error (RESPERROR) and then to RETRY. If a response is not received after a configurable number of retries it transitions to a terminal status of DISCARDED. If a response is received it moves to a terminal status of COMPLETED. -
communicationId: string
Maximum Length:
14
Communication identifier created by Oracle Utilities Digital Asset Cloud Service for each individual communication response received for a conrollable device communication check request
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.