Jump to

• Request
• Response

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

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• responseDetail: object POSTCONTROLLABLEDEVICESTATUS_request_responseDetail

{
    "type":"object",
    "properties":{
        "responseDetail":{
            "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_request_responseDetail"
        }
    },
    "xml":{
        "name":"X1-CDStsChkR"
    }
}

Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "transactionID":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier used to determine the initiating controllable device communication status check transaction."
        },
        "result":{
            "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result"
        }
    }
}

Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result

Type: object

Show Source

• status: string
  Allowed Values: [ "SUCCESS", "FAILURE" ]

  The status code of the controllable device communication status check result.: * `SUCCESS` - Success, * `FAILURE` - Failure

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The status code of the controllable device communication status check result.:\n* `SUCCESS` - Success,\n* `FAILURE` - Failure",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• responseDetail: object POSTCONTROLLABLEDEVICESTATUS_request_responseDetail

{
    "type":"object",
    "properties":{
        "responseDetail":{
            "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_request_responseDetail"
        }
    },
    "xml":{
        "name":"X1-CDStsChkR"
    }
}

Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "transactionID":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier used to determine the initiating controllable device communication status check transaction."
        },
        "result":{
            "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result"
        }
    }
}

Nested Schema : POSTCONTROLLABLEDEVICESTATUS_request_responseDetail_result

Type: object

Show Source

• status: string
  Allowed Values: [ "SUCCESS", "FAILURE" ]

  The status code of the controllable device communication status check result.: * `SUCCESS` - Success, * `FAILURE` - Failure

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The status code of the controllable device communication status check result.:\n* `SUCCESS` - Success,\n* `FAILURE` - Failure",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1-CDStsChkR

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "communicationId":{
            "maxLength":14,
            "type":"string",
            "description":"Communication identifier created by Oracle Utilities Digital Asset Cloud Service for each individual communication response received for a conrollable device communication check request"
        },
        "boStatus":{
            "maxLength":12,
            "type":"string",
            "description":"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."
        }
    },
    "xml":{
        "name":"X1-CDStsChkR"
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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 problemDetailDocument_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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "maxLength":60,
            "type":"string",
            "description":"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."
        },
        "title":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "description":"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."
        },
        "stackTrace":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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 problemDetailDocument_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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "maxLength":60,
            "type":"string",
            "description":"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."
        },
        "title":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "description":"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."
        },
        "stackTrace":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top