Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ SmartCare Interface/ Interface (queryquickresult) for Querying SmartCare Quick Demarcation Results
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface (queryquickresult) for Querying SmartCare Quick Demarcation Results

Description

Query the SmartCare quick demarcation results.

Interface Method

POST

URI

https://Domain name/apiaccess/CC-Management/v1/smartcare/queryquickresult (for example, service.besclouds.com)

Request Description

Table 1 Parameters in the request header

No.

Parameter

Type

Mandatory

Description

1

X-APP-Key

string

True

App key, which is the user ID.

2

Authorization

string

True

Authentication field. The format is Bearer (space){Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)
Table 2 Parameter in the request body

No.

Parameter

Type

Mandatory

Description

1

taskId

string

True

ID of the SmartCare quick demarcation task created in Interface (submitquickdelimit) for Creating a SmartCare Quick Demarcation Task.

Response Description

  • Status code: 200
    Table 3 Parameters in the response body

    No.

    Parameter

    Type

    Mandatory

    Description

    1

    returnCode

    String

    True

    Response code. The value 0 indicates success.

    2

    description

    String

    True

    Response description.

    3

    rootcause

    JSONObject

    True

    Root cause.

    3.1

    futureAnalysis

    String

    True

    Fault cause.

    3.2

    faultAttribution

    String

    True

    Fault category.

    3.3

    diagnosisItem

    String

    True

    Check item.

    3.4

    suggestion

    String

    True

    Handling suggestion.

    3.5

    sceneDescription

    String

    True

    Remarks.

    3.6

    reserved1

    String

    True

    Reserved information 1

    3.7

    reserved2

    String

    True

    Reserved information 2

    3.8

    reserved3

    String

    True

    Reserved information 3

    3.9

    reserved4

    String

    True

    Reserved information 4

    4

    abnormallist

    List< JSONObject>

    True

    Possible cause.

    4.1

    futureAnalysis

    String

    True

    Fault cause.

    4.2

    faultAttribution

    String

    True

    Fault category.

    4.3

    diagnosisItem

    String

    True

    Check item.

    4.4

    suggestion

    String

    True

    Handling suggestion.

    4.5

    sceneDescription

    String

    True

    Remarks.

    4.6

    reserved1

    String

    True

    Reserved information 1.

    4.7

    reserved2

    String

    True

    Reserved information 2.

    4.8

    reserved3

    String

    True

    Reserved information 3.

    4.9

    reserved4

    String

    True

    Reserved information 4.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Message Example

Request header:

x-app-key:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json

Request parameters:

{
    "taskId": "7532351aa3fb4fcc9eff66e6d5606f7f"
}

Response parameters:

{
    "returnCode": "0",
    "description": "Queried successfully. Data is available.",
    "rootcause": {
        "Suggestion": "",
        "FaultAttribution": "",
        "Scene Description": "Fault tree not configured",
        "Reserved5": "",
        "Reserved4": "",
        "Future Analysis": "",
        "Reserved1": "",
        "DiagnosisItem": "",
        "Reserved3": "",
        "Reserved2": ""
    },
    "abnormallist": []
}
Parent topic: SmartCare Interface