GetPropertySetFieldOptions API¶

Returns the available option values for a property set field. For static fields (COMBO BOX, LIST BOX, RADIO BUTTON), returns the list of stored option values. For LOOKUP fields, executes the configured external database query and returns the live results. An optional OptionFilter string can be used to narrow down lookup results.

Endpoint¶

/srv.asmx/GetPropertySetFieldOptions

Methods¶

GET /srv.asmx/GetPropertySetFieldOptions?authenticationTicket=...&PropertySetName=...&PropertyFieldName=...&OptionFilter=...
POST /srv.asmx/GetPropertySetFieldOptions (form data)
SOAP Action: http://tempuri.org/GetPropertySetFieldOptions

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`PropertySetName`	string	Yes	Internal name of the property set.
`PropertyFieldName`	string	Yes	Internal name of the field whose options to retrieve.
`OptionFilter`	string	No	Filter string to narrow results. Used as a SQL `WHERE` clause parameter for `LOOKUP` fields. Ignored for static fields.

Response¶

Static Field Response (COMBO BOX, LIST BOX, RADIO BUTTON)¶

Options are returned alphabetically sorted by value.

<response success="true" error="">
  <options>
    <option value="Active" />
    <option value="Draft" />
    <option value="In Progress" />
    <option value="Rejected" />
  </options>
</response>

LOOKUP Field Response¶

For external database lookup fields, columns from the SQL query result are returned as attributes. The column names in the result set become attribute names on each <option> element.

<response success="true" error="">
  <options>
    <option CategoryName="Engineering" CategoryCode="ENG" />
    <option CategoryName="Finance" CategoryCode="FIN" />
    <option CategoryName="Legal" CategoryCode="LEG" />
  </options>
</response>

Error Response¶

<response success="false" error="Custom Property field not found." />

Required Permissions¶

Any authenticated user may call this API.

Anonymous callers are blocked from accessing private property sets (PrivatePropertySet = TRUE).

Eligible Field Control Types¶

Control Type	Supports GetPropertySetFieldOptions
`COMBO BOX`	Yes -" returns static option list
`LIST BOX`	Yes -" returns static option list
`RADIO BUTTON`	Yes -" returns static option list
`LOOKUP`	Yes -" executes the configured database query
`TEXT BOX`	Yes -" returns empty `<options/>` (no options defined)
`CHECK BOX`	Yes -" returns empty `<options/>` (no options defined)

Example¶

GET Request -" static field¶

GET /srv.asmx/GetPropertySetFieldOptions
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &PropertySetName=ProjectMetadata
    &PropertyFieldName=STATUS
HTTP/1.1
Host: yourserver

GET Request -" lookup field with filter¶

GET /srv.asmx/GetPropertySetFieldOptions
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &PropertySetName=ProjectMetadata
    &PropertyFieldName=CATEGORY
    &OptionFilter=Eng
HTTP/1.1
Host: yourserver

POST Request¶

POST /srv.asmx/GetPropertySetFieldOptions HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&PropertySetName=ProjectMetadata&PropertyFieldName=STATUS&OptionFilter=

Notes¶

PropertyFieldName lookup is case-insensitive -" the field name is matched against the uppercase field names stored in the property set.
Static options are returned sorted alphabetically by value.
For LOOKUP fields, the OptionFilter value is passed to the configured SQL query's filter parameter. The exact behavior depends on the SQL sentence configured for the field.
To add a static option, use AddPropertySetFieldOption. To remove one, use DeletePropertySetFieldOption.
To configure a LOOKUP field's data source, use SetPropertySetLookupFieldParametersForSQLServer, SetPropertySetLookupFieldParametersForMYSQL, or SetPropertySetLookupFieldParametersForORACLE.

AddPropertySetFieldOption -" Add a static option value to a field.
DeletePropertySetFieldOption -" Remove a static option value from a field.
GetPropertySetDefinition -" Get the full property set definition including field metadata.
SetPropertySetLookupFieldParametersForSQLServer -" Configure a LOOKUP field to query SQL Server.

Error Codes¶

Error	Description
`[900]`	Authentication failed -" invalid credentials.
`[901]`	Session expired or invalid authentication ticket.
Access Denied	Property set is private and the caller is anonymous.
Property set not found	No property set with the specified `PropertySetName` exists.
Field not found	No field with the specified `PropertyFieldName` exists in the property set.
Lookup error	The external database query for a LOOKUP field failed.