Class ApiConstants.QueryParameters

java.lang.Object

com.bluebell.greenhouse.planter.constants.ApiConstants.QueryParameters

Enclosing class:

ApiConstants

public static final class ApiConstants.QueryParameters
extends Object

Query parameter names used by both planter and the testing module.

Unless otherwise noted, parameter values are expected to be provided as URL/query-string values.

Version:

3.0.6

Author:

Stephen Prizio

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ApiConstants.QueryParameters.Analysis	Parameters specific to analysis-related endpoints.
static final class	ApiConstants.QueryParameters.Position	Parameters specific to trade-related endpoints.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCOUNT_NUMBER	Account identifier (numeric).
static final String	ACTIVE	Is active.
static final String	AS_OF	As-of date for analysis windows.
static final String	CLOSED_AFTER	Position closed lower-bound filter.
static final String	CLOSED_BEFORE	Position closed upper-bound filter.
static final String	CONTENT	Free-form text content parameter.
static final String	COUNT	Generic count/limit parameter for result sizing.
static final String	COUNTRY	ISO 3166-1 alpha-3 country code (e.g., CAN, USA).
static final String	CURRENCY	ISO 4217 currency code (e.g., CAD, USD).
static final String	DATA_SOURCE	Data source.
static final String	DATE	Calendar date for date-based queries, ISO-8601 (e.g., 2025-08-30).
static final String	DATE_TIME_FORMAT	Optional date time format pattern used for exports.
static final String	DISABLED	Disabled filter.
static final String	DRY_RUN	Whether a data migration should preview changes without saving them.
static final String	EMAIL	Email address for user-scoped queries.
static final String	END	End timestamp/offset for range queries.
static final String	ENDPOINT	Target endpoint/path name when routing or proxying requests.
static final String	ERROR_CODE	Machine-readable error code returned by an endpoint.
static final String	EXCHANGE_MIC	Exchange MIC.
static final String	FAMILY	Position family filter.
static final String	FILE	File upload or reference parameter name.
static final String	FORWARD_HORIZON_BARS	Requested forward-move horizon bars.
static final String	IMPORT_FORMAT	Import format selector for multipart import endpoints.
static final String	INCOMING_PING_TYPE	Incoming ping/event type token.
static final String	INTERVAL	Generic interval token (e.g., 1D, 1W, 1M); semantics depend on endpoint.
static final String	JOB_ID	Job identifier (string/UUID).
static final String	JOB_STATUS	Job status filter (e.g., PENDING/RUNNING/SUCCEEDED/FAILED).
static final String	JOB_TYPE	Job type filter (implementation-specific token).
static final String	LIMIT	Generic limit parameter for provider-backed result sizing.
static final String	LOCALES	Requested locales for content negotiation (comma-separated BCP 47 tags, e.g., en-US,fr-CA).
static final String	LOOKBACK_BARS	Look back bars for analysis windows.
static final String	LOOKBACK_DAYS	Lookback period in days for rolling summary calculations.
static final String	NEW_SYMBOL_ID	New symbol id.
static final String	NOTIFICATION_TYPE	Recurring notification type filter (e.g., MARKET_EVENTS).
static final String	OFFSET	Generic offset parameter for provider-backed pagination.
static final String	OLD_SYMBOL_ID	Old symbol id.
static final String	OPEN	Open-state filter.
static final String	OPENED_AFTER	Position opened lower-bound filter.
static final String	OPENED_BEFORE	Position opened upper-bound filter.
static final String	PAGE	Page number for paginated endpoints (1-based unless documented otherwise).
static final String	PAGE_SIZE	Page size for paginated endpoints (positive integer).
static final String	PORTFOLIO_NUMBER	Portfolio identifier (numeric).
static final String	POSITION_ASSIGNED	Whether an entity has a position assignment.
static final String	POSITION_NUMBER	Position number.
static final String	POSITION_TYPE	Position type filter.
static final String	POSITION_UID	Encoded position uid.
static final String	PRICE_INTERVAL	Price aggregation interval for market data (e.g., 1m, 5m, 1h, 1d).
static final String	QUERY	Search query.
static final String	REPORT_HEADERS	Report header profile selector for csv exports.
static final String	RESET_PASSWORD_TOKEN	Reset password api token.
static final String	SENTIMENT_BUCKET_DAYS	Sentiment aggregation bucket size in days.
static final String	SIGMA_THRESHOLDS	Requested sigma thresholds.
static final String	SORT	Sort expression.
static final String	START	Start timestamp/offset for range queries.
static final String	STRATEGY_IMPLEMENTATION_TYPE	Strategy implementation type.
static final String	STRATEGY_IMPLEMENTATION_UID	Strategy implementation uid.
static final String	STRATEGY_REFERENCE_CODE	Strategy reference code.
static final String	STRATEGY_REFERENCE_CODES	Requested strategy reference codes.
static final String	STRATEGY_UID	Strategy uid.
static final String	SYMBOL	Instrument/symbol code (e.g., AAPL, EURUSD).
static final String	SYMBOL_ALIAS_UID	Symbol alias uid.
static final String	SYMBOL_ID	Symbol id.
static final String	SYMBOL_REVISION	Symbol revision.
static final String	SYMBOL_TYPE	Symbol type.
static final String	SYMBOL_UID	Symbol uid.
static final String	SYSTEM_NAME	Logical system/source name for cross-system requests.
static final String	TAGS	News or topic tag.
static final String	TICKER	Symbol ticker.
static final String	TIME_ZONE	IANA time zone id (e.g., America/Toronto).
static final String	TRANSACTION_NUMBER	Transaction identifier/number (numeric).
static final String	TRANSACTION_STATUS	Transaction status filter (e.g., PENDING/POSTED/CANCELLED).
static final String	TRANSACTION_TYPE	Transaction type filter (e.g., DEBIT/CREDIT/BUY/SELL).
static final String	TRANSACTION_TYPES	Multi-value transaction type filter.
static final String	UID	Generic uid.
static final String	USERNAME	Username identifier for user-scoped queries.
static final String	WATCHLIST_ITEM_UID	Watchlist item uid.
static final String	WATCHLIST_UID	Watchlist uid.

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ACCOUNT_NUMBER

public static final String ACCOUNT_NUMBER

Account identifier (numeric).

See Also:

• Constant Field Values

PORTFOLIO_NUMBER

public static final String PORTFOLIO_NUMBER

Portfolio identifier (numeric).

See Also:

• Constant Field Values

SYMBOL_ID

public static final String SYMBOL_ID

Symbol id.

See Also:

• Constant Field Values

SYMBOL_UID

public static final String SYMBOL_UID

Symbol uid.

See Also:

• Constant Field Values

TICKER

public static final String TICKER

Symbol ticker.

See Also:

• Constant Field Values

EXCHANGE_MIC

public static final String EXCHANGE_MIC

Exchange MIC.

See Also:

• Constant Field Values

SYMBOL_TYPE

public static final String SYMBOL_TYPE

Symbol type.

See Also:

• Constant Field Values

INTERVAL

public static final String INTERVAL

Generic interval token (e.g., 1D, 1W, 1M); semantics depend on endpoint.

See Also:

• Constant Field Values

PRICE_INTERVAL

public static final String PRICE_INTERVAL

Price aggregation interval for market data (e.g., 1m, 5m, 1h, 1d).

See Also:

• Constant Field Values

JOB_ID

public static final String JOB_ID

Job identifier (string/UUID).

See Also:

• Constant Field Values

START

public static final String START

Start timestamp/offset for range queries. Expected format ISO-8601 date or datetime (e.g., 2025-08-30 or 2025-08-30T09:00:00Z).

See Also:

• Constant Field Values

END

public static final String END

End timestamp/offset for range queries. Expected format ISO-8601 date or datetime (e.g., 2025-08-30 or 2025-08-30T17:00:00Z).

See Also:

• Constant Field Values

JOB_STATUS

public static final String JOB_STATUS

Job status filter (e.g., PENDING/RUNNING/SUCCEEDED/FAILED).

See Also:

• Constant Field Values

JOB_TYPE

public static final String JOB_TYPE

Job type filter (implementation-specific token).

See Also:

• Constant Field Values

SYMBOL

public static final String SYMBOL

Instrument/symbol code (e.g., AAPL, EURUSD).

See Also:

• Constant Field Values

DATE

public static final String DATE

Calendar date for date-based queries, ISO-8601 (e.g., 2025-08-30).

See Also:

• Constant Field Values

LOCALES

public static final String LOCALES

Requested locales for content negotiation (comma-separated BCP 47 tags, e.g., en-US,fr-CA).

See Also:

• Constant Field Values

USERNAME

public static final String USERNAME

Username identifier for user-scoped queries.

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

Email address for user-scoped queries.

See Also:

• Constant Field Values

SYSTEM_NAME

public static final String SYSTEM_NAME

Logical system/source name for cross-system requests.

See Also:

• Constant Field Values

INCOMING_PING_TYPE

public static final String INCOMING_PING_TYPE

Incoming ping/event type token.

See Also:

• Constant Field Values

PAGE

public static final String PAGE

Page number for paginated endpoints (1-based unless documented otherwise).

See Also:

• Constant Field Values

PAGE_SIZE

public static final String PAGE_SIZE

Page size for paginated endpoints (positive integer).

See Also:

• Constant Field Values

SORT

public static final String SORT

Sort expression. Common patterns: field, field,asc, or field,desc. Multiple fields may be comma-separated.

See Also:

• Constant Field Values

TRANSACTION_TYPE

public static final String TRANSACTION_TYPE

Transaction type filter (e.g., DEBIT/CREDIT/BUY/SELL).

See Also:

• Constant Field Values

TRANSACTION_TYPES

public static final String TRANSACTION_TYPES

Multi-value transaction type filter.

See Also:

• Constant Field Values

TRANSACTION_STATUS

public static final String TRANSACTION_STATUS

Transaction status filter (e.g., PENDING/POSTED/CANCELLED).

See Also:

• Constant Field Values

NOTIFICATION_TYPE

public static final String NOTIFICATION_TYPE

Recurring notification type filter (e.g., MARKET_EVENTS).

See Also:

• Constant Field Values

TRANSACTION_NUMBER

public static final String TRANSACTION_NUMBER

Transaction identifier/number (numeric).

See Also:

• Constant Field Values

POSITION_UID

public static final String POSITION_UID

Encoded position uid.

See Also:

• Constant Field Values

POSITION_ASSIGNED

public static final String POSITION_ASSIGNED

Whether an entity has a position assignment.

See Also:

• Constant Field Values

FILE

public static final String FILE

File upload or reference parameter name.

See Also:

• Constant Field Values

COUNT

public static final String COUNT

Generic count/limit parameter for result sizing.

See Also:

• Constant Field Values

LOOKBACK_DAYS

public static final String LOOKBACK_DAYS

Lookback period in days for rolling summary calculations.

See Also:

• Constant Field Values

LIMIT

public static final String LIMIT

Generic limit parameter for provider-backed result sizing.

See Also:

• Constant Field Values

DRY_RUN

public static final String DRY_RUN

Whether a data migration should preview changes without saving them.

See Also:

• Constant Field Values

OFFSET

public static final String OFFSET

Generic offset parameter for provider-backed pagination.

See Also:

• Constant Field Values

REPORT_HEADERS

public static final String REPORT_HEADERS

Report header profile selector for csv exports.

See Also:

• Constant Field Values

TIME_ZONE

public static final String TIME_ZONE

IANA time zone id (e.g., America/Toronto).

See Also:

• Constant Field Values

CONTENT

public static final String CONTENT

Free-form text content parameter.

See Also:

• Constant Field Values

COUNTRY

public static final String COUNTRY

ISO 3166-1 alpha-3 country code (e.g., CAN, USA).

See Also:

• Constant Field Values

CURRENCY

public static final String CURRENCY

ISO 4217 currency code (e.g., CAD, USD).

See Also:

• Constant Field Values

ENDPOINT

public static final String ENDPOINT

Target endpoint/path name when routing or proxying requests.

See Also:

• Constant Field Values

ERROR_CODE

public static final String ERROR_CODE

Machine-readable error code returned by an endpoint.

See Also:

• Constant Field Values

RESET_PASSWORD_TOKEN

public static final String RESET_PASSWORD_TOKEN

Reset password api token.

See Also:

• Constant Field Values

SYMBOL_REVISION

public static final String SYMBOL_REVISION

Symbol revision.

See Also:

• Constant Field Values

TAGS

public static final String TAGS

News or topic tag.

See Also:

• Constant Field Values

ACTIVE

public static final String ACTIVE

Is active.

See Also:

• Constant Field Values

QUERY

public static final String QUERY

Search query.

See Also:

• Constant Field Values

DISABLED

public static final String DISABLED

Disabled filter.

See Also:

• Constant Field Values

DATA_SOURCE

public static final String DATA_SOURCE

Data source.

See Also:

• Constant Field Values

OLD_SYMBOL_ID

public static final String OLD_SYMBOL_ID

Old symbol id.

See Also:

• Constant Field Values

NEW_SYMBOL_ID

public static final String NEW_SYMBOL_ID

New symbol id.

See Also:

• Constant Field Values

SYMBOL_ALIAS_UID

public static final String SYMBOL_ALIAS_UID

Symbol alias uid.

See Also:

• Constant Field Values

STRATEGY_UID

public static final String STRATEGY_UID

Strategy uid.

See Also:

• Constant Field Values

STRATEGY_REFERENCE_CODE

public static final String STRATEGY_REFERENCE_CODE

Strategy reference code.

See Also:

• Constant Field Values

STRATEGY_IMPLEMENTATION_UID

public static final String STRATEGY_IMPLEMENTATION_UID

Strategy implementation uid.

See Also:

• Constant Field Values

STRATEGY_IMPLEMENTATION_TYPE

public static final String STRATEGY_IMPLEMENTATION_TYPE

Strategy implementation type.

See Also:

• Constant Field Values

AS_OF

public static final String AS_OF

As-of date for analysis windows.

See Also:

• Constant Field Values

LOOKBACK_BARS

public static final String LOOKBACK_BARS

Look back bars for analysis windows.

See Also:

• Constant Field Values

SENTIMENT_BUCKET_DAYS

public static final String SENTIMENT_BUCKET_DAYS

Sentiment aggregation bucket size in days.

See Also:

• Constant Field Values

FORWARD_HORIZON_BARS

public static final String FORWARD_HORIZON_BARS

Requested forward-move horizon bars.

See Also:

• Constant Field Values

SIGMA_THRESHOLDS

public static final String SIGMA_THRESHOLDS

Requested sigma thresholds.

See Also:

• Constant Field Values

STRATEGY_REFERENCE_CODES

public static final String STRATEGY_REFERENCE_CODES

Requested strategy reference codes.

See Also:

• Constant Field Values

WATCHLIST_UID

public static final String WATCHLIST_UID

Watchlist uid.

See Also:

• Constant Field Values

WATCHLIST_ITEM_UID

public static final String WATCHLIST_ITEM_UID

Watchlist item uid.

See Also:

• Constant Field Values

UID

public static final String UID

Generic uid.

See Also:

• Constant Field Values

OPENED_AFTER

public static final String OPENED_AFTER

Position opened lower-bound filter.

See Also:

• Constant Field Values

OPENED_BEFORE

public static final String OPENED_BEFORE

Position opened upper-bound filter.

See Also:

• Constant Field Values

CLOSED_AFTER

public static final String CLOSED_AFTER

Position closed lower-bound filter.

See Also:

• Constant Field Values

CLOSED_BEFORE

public static final String CLOSED_BEFORE

Position closed upper-bound filter.

See Also:

• Constant Field Values

FAMILY

public static final String FAMILY

Position family filter.

See Also:

• Constant Field Values

OPEN

public static final String OPEN

Open-state filter.

See Also:

• Constant Field Values

POSITION_TYPE

public static final String POSITION_TYPE

Position type filter.

See Also:

• Constant Field Values

POSITION_NUMBER

public static final String POSITION_NUMBER

Position number.

See Also:

• Constant Field Values

DATE_TIME_FORMAT

public static final String DATE_TIME_FORMAT

Optional date time format pattern used for exports.

See Also:

• Constant Field Values

IMPORT_FORMAT

public static final String IMPORT_FORMAT

Import format selector for multipart import endpoints.

See Also:

• Constant Field Values