Creating a Dictionary

Function

This API is used to create a dictionary.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document.

Request Parameters

**Table 2** 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).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Dictionary name. Characters allowed: letters, digits, underscores (_), and spaces. Constraints: The value must be unique in an instance.
remark	No	String	Dictionary description.
code	Yes	String	Dictionary code. Characters allowed: letters, digits, underscores (_), and spaces. Constraints: The value must be unique in an instance.
order	No	Integer	Dictionary order. A smaller value indicates a higher order.
extend_one	No	String	Extended field 1. Characters allowed: letters, digits, underscores (_), and spaces.
extend_two	No	String	Extended field 2. Characters allowed: letters, digits, underscores (_), and spaces.
parent_code	No	String	Parent dictionary code. If the value is null, the dictionary is a top-level dictionary.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Dictionary ID.
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.
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	String	Time when the dictionary was created.
update_time	String	Time when the dictionary was updated.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_details	String	Error information.
request_id	String	Request ID.

Example Requests

Create a data dictionary, specify the dictionary name and code, and set the dictionary sequence to 1.

{
  "name" : "DictName",
  "remark" : "example",
  "code" : "13760c1fe8655e61209b75665e9bef43",
  "order" : "1",
  "extend_one" : "param1",
  "extend_two" : "param2",
  "parent_code" : ""
}

Example Responses

Status code: 200

{
  "id" : "string",
  "name" : "string",
  "remark" : "string",
  "code" : "string",
  "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"
}