Skip to main content
API docs by Redocly

System Code

Download OpenAPI specification:Download

System code:

Authentication

Sign

Security Scheme Type: API Key
Header parameter name: Authorization

systemcodes

System code

Retrieve a Paginated List of Code Values

Retrieve a paginated list of code values based on the entity code

Authorizations:
Sign
path Parameters
entityCode
required
string

The entity code is required (exact match)

query Parameters
keyword
string

Query data by fuzzy matching the code or name of the code value

includeDeleted
boolean

Whether to include deleted code values, default is false (Code values are logically deleted. This parameter is used to control whether to include deleted code values in the query. The default value is false, which means deleted code values are not included))

current
required
integer
Default: 1

Current page number, starting from 1

pageSize
required
integer <= 100
Default: 20

Number of items per page (default is 20 and maximum is 100)

header Parameters
Accept-Language
string <= 8 characters
Example: zh-cn

Internationalization language (system code values will be returned in different languages based on the selected language). Default is the language of the server's operating system. English: en-us, Chinese: zh-cn.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pagination": {
    }
}

Retrieve Details of Specified Code Values

Retrieve details of specified code values based on the entity code and code values

Authorizations:
Sign
path Parameters
entityCode
required
string

The entity code is required (exact match)

valueCodes
required
Array of strings

The code values in an array format, with a maximum length of 20 (If a code value in the parameter does not exist, it will not be returned. Only valid code values will be returned)

query Parameters
includeDeleted
boolean

Whether to include deleted code value data, default is false (Deletion of code values is a logical deletion. This parameter controls whether to include deleted code value data in the query. Default is false, which means deleted code value data will not be included)

header Parameters
Accept-Language
string <= 8 characters
Example: zh-cn

Internationalization language (system code values will be returned in different languages based on the selected language). Default is the language of the server's operating system. English: en-us, Chinese: zh-cn.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}