Querying Task Details

Description

This interface is invoked to query task details by task ID.

Method

POST

URI

https://Domain name/service/AICC__Case/1.0.0/openapi/task/{id} (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	Yes	Request body type, which is JSON
2	access-token	String	Yes	Token for a user to access a tenant space. For details, see 2.

**Table 2** Request body parameters
No.	Parameter	Type	Length (Bytes)	Mandatory or Not	Description
1	id	String	20	Yes	Task ID

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1	taskInfo	TaskInfo	Yes	Task information. For details about the parameters of this object, see Table 4.
2	taskTrace	CaseTrace []	No	Task track. For details about the parameters of this object, see Table 5.
3	customerInfo	Object	No	Contact information. For details about the parameters of this object, see Table 6.
4	caseInfos	Case	No	Associated case information. For details about the parameters of this object, see Table 6.

**Table 4** TaskInfo parameters
No.	Parameter	Type	Mandatory or Not	Description
1	title	String	Yes	Task title
2	description	String	No	Task description
3	type	String	No	Associated task type
4	relateId	String	No	If the associated task type is set, this parameter must also be set.
5	ownerId	String	Yes	Handler ID
6	contactId	String	No	Contact ID
7	priority	String	No	Priority
8	dueDate	Datetime	No	Deadline, in YYYY-MM-DD HH:mm:ss format
9	creatorId	String	Yes	Creator
10	creatorName	String	Yes	Creator name
11	createdDate	Datetime	Yes	Creation time, in YYYY-MM-DD HH:mm:ss format
12	closedDate	Datetime	No	Closure time, in YYYY-MM-DD HH:mm:ss format
13	stayDate	Datetime	No	Stay duration, in YYYY-MM-DD HH:mm:ss format
14	taskNo	String	No	Task No.
15	ownerName	String	No	Handler name
16	id	String	No	Task ID
17	status	String	No	Task status
18	attachment	String	No	Task attachment

**Table 5** CaseTrace parameters
No.	Parameter	Type	Mandatory or Not	Description
1	creatorId	String	Yes	Case handler ID
2	creatorName	String	Yes	Case handler name
3	type	String	Yes	Handling type, which can be CreateTask or StatusUpdate
4	relatedId	String	No	Associated record ID
5	title	String	No	Title
6	description	String	No	Handling description

**Table 6** Case parameters
No.	Parameter	Type	Mandatory or Not	Description
1	id	String	Yes	Case ID
2	caseNo	String	Yes	Case No.
3	status	String	Yes	Case status dataType: SingleSelect Value range: 0. Completed (default value) Other values are defined by the business side.
4	title	String	No	Case title
5	priority	String	No	Priority dataType: SingleSelect Value range: Critical High Medium Low
6	parentId	String	No	Parent case ID
7	ownerId	String	Yes	Handler ID
8	origin	String	Yes	Priority dataType: SingleSelect Value range: Voice Whatsapp webchat Email
9	isUpgraded	Boolean	Yes	Whether the case is upgraded
10	extternalNo	String	Yes	External case No.
11	dueDate	Datetime	No	Deadline, in YYYY-MM-DD HH:mm:ss format
12	description	String	Yes	Case description
13	creatorId	String	Yes	Case handler ID
14	createdDate	Datetime	Yes	Creation time, in YYYY-MM-DD HH:mm:ss format
15	contactId	String	No	Contact ID
16	reason	String	Yes	Case reason category
17	contactPhone	String	No	Contact phone number
18	state	String	Yes	Task status dataType: SingleSelect Value range: Completed Pending Processing
19	stayDate	String	Yes	Stay duration of the current case status, in YYYY-MM-DD HH:mm:ss format
20	suspendAccumulatedTime	int	Yes	Case stay duration, in minutes. The value ranges from 1 to 1439999.
21	suspendDate	String	Yes	Time when the case is suspended, in YYYY-MM-DD HH:mm:ss format
22	type	String	Yes	Case type ID, which is associated with the CaseType table
23	closedDate	Datetime	No	Closure time
24	attachment	String	No	Case attachment

Example

Scenario: Query task details.

URL: https://Domain name/service/AICC__Case/1.0.0/openapi/task/{id}

Request header

{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}

Request body

{
   "id":"ccqG00000138H6u8bTwe"
}

Response header

{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}

Response parameters

{
    "resCode": "0",
    "resMsg": "Success",
    "result": {
        "caseInfos": [
            {
                "attachment": "",
                "caseNo": "000000000000000000000000000006",
                "closedDate": null,
                "contactId": "ciIy0000013y7cC8T2rA",
                "contactPhone": null,
                "createdDate": "2023-07-07 14:43:15",
                "creatorId": "10gg00000148QvgpaLAm",
                "description": "0704test",
                "dueDate": "2023-07-22 00:00:00",
                "extternalNo": null,
                "id": "c6m80000014iXKHqDw3c",
                "isUpgraded": false,
                "origin": "Voice",
                "ownerId": "10gg00000148QvgpaLAm",
                "parentId": null,
                "priority": "Low",
                "reason": null,
                "state": "Processing",
                "status": "tttttt",
                "stayDate": null,
                "suspendAccumulatedTime": null,
                "suspendDate": null,
                "title": "0704test",
                "type": "cvmC0000014ddysLTCZk"
            }
        ],
        "customerInfo": {
            "customerInfo": {
                "address": {
                    "addressLine1": null,
                    "addressLine2": null,
                    "addressLine3": null,
                    "addressLine4": null,
                    "addressLine5": null,
                    "addtionalAddress": null,
                    "area": null,
                    "block": null,
                    "buildingNo": null,
                    "city": null,
                    "country": null,
                    "defaultBillingAddress": false,
                    "defaultShippingAddress": false,
                    "firstName": null,
                    "id": "cw8O0000013y7cCDIE4G",
                    "label": null,
                    "lastName": null,
                    "middleName": null,
                    "phoneNumber1": null,
                    "phoneNumber2": null,
                    "province": null,
                    "roomNo": null,
                    "street": null,
                    "subjectId": "ciIy0000013y7cC8T2rA",
                    "title": null,
                    "town": null,
                    "zip": null
                },
                "age": null,
                "bindAccount": [],
                "birthDay": null,
                "cellPhone1": "15005167393",
                "cellPhone2": null,
                "cellPhone3": null,
                "channel": null,
                "createdDate": "2023-06-09 15:33:35",
                "customFied": null,
                "customerName": "Customer 1",
                "description": null,
                "email": "customer@huawei.com",
                "email1": null,
                "email2": null,
                "fax": null,
                "firstName": null,
                "gender": null,
                "id": "ciIy0000013y7cC8T2rA",
                "lastModifiedDate": "2023-06-09 15:33:35",
                "lastName": null,
                "level": null,
                "middleName": null,
                "name": null,
                "nickName": null,
                "organization": {
                    "description": null,
                    "email": null,
                    "fax": null,
                    "fixedPhone": null,
                    "id": "cBbs0000013y7cBnkKMS",
                    "industry": null,
                    "logo": null,
                    "organizationName": "Company",
                    "scale": null,
                    "summary": null,
                    "website": null
                },
                "organizationId": "cBbs0000013y7cBnkKMS",
                "phone": null,
                "phone1": null,
                "phone2": null,
                "phone3": null,
                "picture": null,
                "remark": null,
                "status": null,
                "title": null,
                "website": null
            }
        },
        "taskInfo": {
            "attachment": "",
            "closedDate": null,
            "contactId": "ciIy0000013y7cC8T2rA",
            "createdDate": "2023-07-07 14:51:35",
            "creatorId": "10gg00000148QvgpaLAm",
            "creatorName": "10gg00000148QvgpaLAm",
            "description": "test001",
            "dueDate": "2023-07-08 00:00:00",
            "id": "ccqG0000014iXvGKONQO",
            "ownerId": "10gg00000148QvgpaLAm",
            "ownerName": "liuhuqiong001",
            "priority": "Low",
            "relateId": "c6m80000014iXKHqDw3c",
            "status": "Pending",
            "stayDate": null,
            "taskNo": "000000000000000000000000001002",
            "title": "test002",
            "type": "Case"
        },
        "taskTrace": [
            {
                "creatorId": "10gg00000148QvgpaLAm",
                "creatorName": "10gg00000148QvgpaLAm",
                "description": null,
                "relatedId": null,
                "title": null,
                "type": "CreateTask"
            }
        ]
    }
}