Querying the Case Type List

Description

This interface is invoked to query the case type list based on conditions. Fuzzy query by type name, filtering by status, and pagination query are supported. By default, a maximum of 100 records can be displayed on each page.

Method

POST

URI

https://Domain name/service/AICC__Case/1.0.0/openapi/caseType/list (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Parameters in the request header
No.	Parameter	Type	Mandatory	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** Parameters in the request body
No.	Parameter	Type	Length (Bytes)	Mandatory	Description
1	typeName	String	128	No	Case type name for fuzzy query
2	status	String	-	No	Type status, which can be Active or Inactive
3	start	Number	-	Yes	Start row number (minimum value: 0)
4	limit	Number	-	Yes	Number of rows returned for the query (minimum value: 1; maximum value: 100)

Response Description

Status code: 200

**Table 3** Parameters in the response body
No.	Parameter	Type	Mandatory	Description
1	caseTypes	CaseTypes []	Yes	Case type information. For details, see Table 4.
2	count	Number	Yes	Total number of records that meet conditions

**Table 4** CaseTypes parameters
No.	Parameter	Type	Mandatory	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	templateId	String	Yes	Associated case template
7	templateName	String	Yes	Name of the associated case template
8	contentTempalteId	String	No	Associated content template
9	parentId	String	No	Parent type ID
10	isStrictOrder	Boolean	Yes	Whether the strict mode is used
11	creatorName	String	Yes	Creator name
12	createdDate	Datetime	Yes	Creation time
13	lastModifiedName	String	Yes	Last modifier name
14	lastModifiedDate	Datetime	Yes	Last modification time

Example

Scenario: Query the case type list.

URL: https://Domain name/service/AICC__Case/1.0.0/openapi/caseType/list

Request header

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

Request body

{
  "limit": 2,"start": 0
}

Response header

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

Response parameters

{
	"resCode": "0",
	"resMsg": "Successful",
	"result": {
		"caseTypes": [{
			"caseStatus": "y,Completed",
			"contentTemplateId": null,
			"createdDate": "2023-06-16 10:46:37",
			"creatorName": "qianbin001",
			"description": "bbb",
			"id": "cvmC00000149PQzoNeq0",
			"isStrictOrder": false,
			"lastModifiedDate": "2023-06-16 10:46:58",
			"lastModifiedName": "10gd00000143C5ONGb0y",
			"parentId": null,
			"status": "Active",
			"templateId": "c7s800000149PO9VmEWu",
			"templateName": "bbbb",
			"typeName": "bbb"
		}, {
			"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",
			"templateName": "aaa",
			"typeName": "aaa"
		}],
		"count": 65
	}
}

Parent topic: Machine-Machine Interface for Case Configuration

Previous topic: Machine-Machine Interface for Case Configuration

Next topic: Querying Case Type Details