Help Center> ROMA Connect> API Reference> Public Resource APIs> Dictionary Management> Verifying the Existence of a Dictionary
View PDF

Verifying the Existence of a Dictionary

Function

This API is used to check whether the dictionary that meets a given condition exists. Only the dictionary name and code can be used as conditions.

URI

GET /v2/{project_id}/instances/{instance_id}/validate-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

name

No

String

Dictionary name to check. Exact match is used.

Minimum: 0

Maximum: 64

code

No

String

Dictionary code to check. Exact match is used.

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

name

String

Dictionary name.

  • Characters allowed: letters, digits, underscores (_), and spaces

  • Constraints: The value must be unique in an instance.

code

String

Dictionary code.

  • Characters allowed: letters, digits, underscores (_), and spaces

  • Constraints: The value must be unique in an instance.

Status code: 403

Table 5 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

OK

{
  "name" : "MyDict",
  "code" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3"
}

Status code: 404

Not Found

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

Status code: 403

Forbidden

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

Status Codes

Status Code

Description

200

OK

404

Not Found

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Dictionary Management