Updated on 2023-09-27 GMT+08:00

POST /CCSQM/rest/ccisqm/v1/regularqualitytask/queryQualityTask

Scenario

This interface is invoked to query scheduled sample inspection plans.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/regularqualitytask/queryQualityTask (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Content-Type

String

No

The value is fixed to application/json; charset=UTF-8.

2

x-app-key

String

No

App key

3

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

4

x-UserId

String

Yes

Operator ID

You can sign in to the system and go to the employee management page to view the value of userId returned by an interface.

Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

page

Integer

Yes

Page number

1.2

rows

Integer

Yes

Number of records on each page

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

total

Integer

No

Total number of records

1.2

list

Array [Object]

Yes

List of scheduled sample inspection plans

1.2.1

nextExecutionTimeStr

Number

No

Next execution time

1.2.2

qiqtCreateTimeStr

Number

No

Creation time

1.2.3

qiqtCreater

String

No

Creator

1.2.4

qiqtCycleType

String

No

Repetition mode

  • Daily
  • Weekly
  • Monthly

1.2.5

qiqtEndTimeStr

String

No

End time. This parameter is valid only when qiq_end_type is set to 2.

1.2.6

qiqtEndType

String

No

End condition. The options are 1 (number of times) and 2 (time).

1.2.7

qiqtEndTypeStr

String

No

End condition

1.2.8

qiqtExecutionTimes

Number

No

Number of execution times

1.2.9

qiqtId

String

No

ID of a scheduled sample inspection task

1.2.10

qiqtName

String

No

Name of a scheduled task

1.2.11

qiqtStartTimeStr

Number

No

Start time

1.2.12

qiqtStatus

String

No

Status. The options are 1 (stopped) and 2 (running).

1.2.13

qiqtTotalTimes

Number

No

Number of times that a scheduled task is executed

1.2.14

interactionType

String

No

Inspection task type

  • 0: voice
  • 2: text

1.3

resultCode

String

No

Return code

  • 0408000: success
  • Others: failure

1.4

resultDesc

String

No

Return description

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

Error Codes

None

Example

  • Scenario: Query scheduled sample inspection plans.

    Request header:

    Content-Type:application/json  
    x-app-key:xxxx-xxxx-xxxx-xxxx-xxxx  
    x-UserId:xxxx  
    Authorization:Bearer ********************************

    Request parameters:

    {
    	"page": 1,
    	"rows": 10
    }

    Response header:

    Content-Type: application/json;charset=UTF-8
    Response parameters:
    {
    	"total": 2,
    	"list": [{
    		"qiqtStartTimeStr": "2020-12-30 10:27:08",
    		"qiqtEndType": "2",
    		"qiqtEndTypeStr": "Time limit",
    		"qiqtId": "954637368599307266",
    		"nextExecutionTimeStr": "2020-12-31 10:27:08",
    		"qiqtName": "regulartask",
    		"qiqtExecutionTimes": 0,
    		"qiqtTotalTimes": 1,
    		"qiqtCycleType": "Daily",
    		"qiqtStatus": "2",
    		"qiqtCreater": "xxxx",
    		"qiqtCreateTimeStr": "2020-12-30 10:27:33",
    		"qiqtEndTimeStr": "2021-01-02 10:27:08",
                    "interactionType": "0"
    	}, {
    		"qiqtStartTimeStr": "2020-11-23 11:30:00",
    		"qiqtEndType": "2",
    		"qiqtEndTypeStr": "Time limit",
    		"qiqtId": "933182094016018433",
    		"nextExecutionTimeStr": "2020-12-29 11:30:00",
    		"qiqtName": "long1123",
    		"qiqtExecutionTimes": 9,
    		"qiqtTotalTimes": 1,
    		"qiqtCycleType": "Daily",
    		"qiqtStatus": "1",
    		"qiqtCreater": "xxxx",
    		"qiqtCreateTimeStr": "2020-11-23 10:22:48",
    		"qiqtEndTimeStr": "2020-12-30 10:24:50",
                    "interactionType": "0"
    	}],
    	"resultCode": "0408000",
    	"resultDesc": "Operation successful."
    }