Qodex.ai

DimensionOptionsSearchRequestInfo

GET {{base_url}}/DimensionOptionsSearchRequestInfo?DimensionId={{integer}}&IgnoreCompanyId={{boolean}}

Retrieves a list of dimension options search request information.

API
Dimension API

Requires Authentication
Yes

Returns
DimensionSearchOptionInfo

Batch?
No

Request Params

KeyDatatypeRequiredDescription
DimensionIdstringRequired.
(int32)
The identifier of the dimension options to load.
CompanyIdstringOptional.
(int32)
The identifier of the associated company.
NOTE: For information about the company object, see Company.
IgnoreCompanyIdstringRequired.
(int32)
The flag that indicates whether or not it should ignore the company from the dimension, and return one instance of the dimension, instead of one per company.
If true, it ignores the company from the dimension and returns one instance of the dimension. Otherwise it does not.
ActivestringOptional.
(int32)
The flag that indicates whether or not it is active.
If true, the dimension option object is active. Otherwise, it is not.
DisableInactiveParenthesisstringOptional.
(int32)
The flag that indicates whether or not inactive parenthesis is disabled. If true, it disables the addition of parantheses. Otherwise, it does not.
NOTE: By default, this is automatically set to false if not specified.

RESPONSES

status: OK

{"ApproxNumberOfItems":3478,"MaxVisibleItems":50}