Help Center/ Customer Engagement Center/ API Reference/ Case2.0 Interface Reference/ Machine-Machine Interface for Case Configuration/ Querying Case Type Details
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Querying Case Type Details

Description

This interface is invoked to query case type details by ID.

Method

GET

URI

https://Domain name/service/AICC__Case/1.0.0/openapi/caseType/{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
Table 2 Request body parameter

No.

Parameter

Type

Mandatory or Not

Description

1

id

String

Yes

Case template record ID, which is a string of 20 bytes

Response Description

  • Status code: 200

No.

Parameter

Type

Mandatory or Not

Description

1

caseTypeInfo

CaseTypes

Yes

Case type details. For details about the parameters, see Table 3.
Table 3 CaseTypes parameters

No.

Parameter

Type

Mandatory or Not

Description

1

id

String

Yes

Case type ID

2

typeName

String

Yes

Case template name (which must be unique)

3

description

String

No

Case type description

4

status

String

Yes

Type status

5

caseStatus

String

Yes

Case status. Multiple statuses are separated by commas (,).

6

tempalteId

String

Yes

Associated case template

7

contentTempalteId

String

No

Associated content template

8

parentId

String

No

Parent type ID

9

isStrctOrder

Boolean

Yes

Whether the strict mode is used

10

creatorName

String

Yes

Creator name

11

createdDate

Datetime

Yes

Creation time

12

lastModifiedName

String

Yes

Last modifier name

13

lastModifiedDate

Datetime

Yes

Last modification time

Example

Scenario: Query case type details.

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

  • Request header
{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • Request body
{"id": "cvmC00000149NzxF1ePA"}
  • Response header
{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • Response parameters
{ "resCode": "0", "resMsg": "Success", "result": {   "caseTypeInfo": {     "caseStatus": "y,Completed",     "contentTemplateId": null,     "createdDate": "2023-06-16 10:26:31",     "creatorName": "qianbin001",     "description": "aaa",     "id": "cvmC00000149NzxF1ePA",     "isStrictOrder": false,     "lastModifiedDate": "2023-06-16 10:26:50",     "lastModifiedName": "10gd00000143C5ONGb0y",     "parentId": null,     "status": "Active",     "templateId": "c7s800000149NtKyh4me",     "typeName": "aaa"   } }}