Querying Dictionaries

Function

This API is used to query dictionaries.

URI

GET /v2/{project_id}/instances/{instance_id}/dictionaries

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID. Minimum: 0 Maximum: 64
project_id	Yes	String	Project ID. Minimum: 0 Maximum: 64

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	String	Offset, which is greater than or equal to 0. Default: 0 Minimum: 0 Maximum: 64
limit	No	String	Number of items displayed on each page. Default: 10 Minimum: 0 Maximum: 64
parent_code	No	String	Parent dictionary code. The child dictionaries are returned. If this parameter is not specified, the top-level dictionaries are queried. Minimum: 0 Maximum: 64
code	No	String	Code of the dictionary to query. Fuzzy match by dictionary code is supported. Minimum: 0 Maximum: 64
name	No	String	Name of the dictionary to query. Fuzzy match by dictionary name is supported. Minimum: 0 Maximum: 64

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum: 1 Maximum: 100000

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of records, which is irrelevant to pagination. Minimum: 1 Maximum: 128
size	Integer	Number of records displayed on the current page. The value must be less than or equal to the limit specified in the request. Minimum: 1 Maximum: 128
dictionaries	Array of Dictionary objects	Dictionaries.

**Table 5** Dictionary
Parameter	Type	Description
id	String	Dictionary ID. Minimum: 0 Maximum: 64
name	String	Dictionary name. Characters allowed: letters, digits, underscores (_), and spaces Constraints: The value must be unique in an instance.
remark	String	Dictionary description.
code	String	Dictionary code. Characters allowed: letters, digits, underscores (_), and spaces Constraints: The value must be unique in an instance.
order	Integer	Dictionary order. A smaller value indicates a higher order.
extend_one	String	Extended field 1. Characters allowed: letters, digits, underscores (_), and spaces
extend_two	String	Extended field 2. Characters allowed: letters, digits, underscores (_), and spaces
parent_code	String	Parent dictionary code. If the value is null, the dictionary is a top-level dictionary.
type	String	Dictionary type. system: built-in dictionary of the system. It can be edited but cannot be deleted. user: dictionary created by a user.
create_time	Number	Time when the dictionary was created. Minimum: 1 Maximum: 128
update_time	Number	Time when the dictionary was updated. Minimum: 1 Maximum: 128

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 1 Maximum: 128
error_msg	String	Error message. Minimum: 1 Maximum: 128
error_details	String	Error information. Minimum: 1 Maximum: 128
request_id	String	Request ID. Minimum: 1 Maximum: 128

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 0,
  "size" : 0,
  "dictionaries" : [ {
    "id" : "string",
    "name" : "string",
    "remark" : "string",
    "code" : "string",
    "order" : 0,
    "extend_one" : "string",
    "extend_two" : "string",
    "parent_code" : "string",
    "type" : "system",
    "create_time" : "2019-12-06T06:49:04Z",
    "update_time" : "2019-12-06T06:49:04Z"
  } ]
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}