Enum Reference

This document provides a comprehensive reference for all enumerations used in the Apinizer Management API.

Response Status

EnumStatus

Response status values used in all API responses.

Value Description
SUCCESS Operation completed successfully
FAILURE Operation failed

Usage

All API responses include a status field with one of these values.

Example

{
  "status": "SUCCESS",
  "resultList": [...],
  "resultCount": 1
}

API Types

EnumApiType

Type of API Proxy.

Value Description
REST RESTful API
SOAP SOAP Web Service
GRPC gRPC Service
WEBSOCKET WebSocket Service

Usage

Used in API Proxy objects to indicate the API type.

HTTP Methods

EnumHttpRequestMethod

HTTP request methods supported by the API.

Value Description
GET Retrieve resource
POST Create resource or submit data
PUT Update resource (full replacement)
PATCH Update resource (partial update)
DELETE Delete resource
HEAD Retrieve headers only
OPTIONS Retrieve allowed methods
TRACE Echo request for debugging
ALL All HTTP methods

Usage

Used in endpoint definitions, client routes, and policy target specifications.

Policy Scope

EnumPolicyTargetScope

Scope where a policy applies.

Value Description
ALL Policy applies to all endpoints in the API Proxy
ENDPOINT Policy applies only to a specific endpoint

Usage

Used in policy operation metadata (operationMetadata.targetScope).

Note: When targetScope is ENDPOINT, both targetEndpoint and targetEndpointHTTPMethod must be provided.

Policy Pipeline

EnumPolicyTargetPipeline

Pipeline where a policy executes.

Value Description
REQUEST Executes before forwarding request to backend
RESPONSE Executes after receiving response from backend
ERROR Executes when an error occurs

Usage

Used in policy operation metadata (operationMetadata.targetPipeline).

Access Type

EnumAccessType

Type of resource that can be accessed.

Value Description
API_PROXY API Proxy resource
API_PROXY_GROUP API Proxy Group resource

Usage

Used in credential access management to specify which type of resource access is granted.

Variable Types

EnumVariableType

Type of variable used in policies and conditions.

Value Description
HEADER Extract value from HTTP header
PARAMETER Extract value from URL parameter (query, path, or form)
BODY Extract value from request/response body
CONTEXT_VALUES Extract value from context (e.g., current time, IP address)
CUSTOM Custom variable defined with script

Usage

Used in VariableDTO to specify how to extract data.

See Variable Definition for complete documentation.

Variable Parameter Types

EnumVariableParameterType

Type of parameter when VariableDTO.type is PARAMETER.

Value Description
QUERY Query parameter (e.g., ?param=value)
PATH Path parameter (e.g., /users/{id})
FORM Form parameter (from form data)

Usage

Used in VariableDTO.paramType when type is PARAMETER.

Message Content Types

EnumMessageContentType

Content type of message body.

Value Description
JSON JSON format
XML XML format
FORM Form data format

Usage

Used in VariableDTO.messageContentType when extracting data from body (type=BODY).

Script Types

EnumScriptType

Script language for custom variables and script policies.

Value Description
GROOVY Groovy script
JAVASCRIPT JavaScript (Nashorn) script

Usage

Used in VariableDTO.scriptLanguage and script-based policies.

API Proxy Spec Types

EnumApiProxySpecType

Type of API specification used to create an API Proxy.

Value Description
WSDL WSDL (Web Services Description Language) for SOAP APIs
SWAGGER Swagger 2.0 specification
OPEN_API OpenAPI 3.0 specification
REVERSE_PROXY Reverse proxy (no specification file)

Usage

Used when importing or creating API Proxies from specification files.

Condition Value Comparison Operators

EnumConditionValueComparisonOperator

Comparison operators used in policy conditions and RLCL conditions for value comparisons.

Value Description
LT Less than
LE Less than or equal to
GT Greater than
GE Greater than or equal to
EQ Equal to
NE Not equal to
STARTS_WITH Starts with (string only)
ENDS_WITH Ends with (string only)
CONTAINS Contains (string only)
NOT_CONTAINS Does not contain (string only)
IS_EMPTY Value exists and is empty
IS_NOT_EMPTY Value exists and is not empty
IS_EXISTS Value exists
IS_NOT_EXISTS Value does not exist
IN Value is in list
NOT_IN Value is not in list

Usage

Used in ConditionRuleDTO.valueComparisonOperator for policy conditions and RLCL conditions to specify how values should be compared.

Note:

  • Numeric operators (LT, LE, GT, GE, EQ, NE) work with numeric data types.
  • String operators (STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS) work with string data types only.
  • Existence operators (IS_EMPTY, IS_NOT_EMPTY, IS_EXISTS, IS_NOT_EXISTS) check for value existence and emptiness.
  • List operators (IN, NOT_IN) check if a value is present in a list.