Page Comparison

...

• objectname: String - Object name (type)

• description: String - Short description of view

• query: String - Selection query (SQL syntax)

• since

  Status
  title 11.19

  * parameterizedQuery: String or Object - Selection query as SQL syntaxe or JSON Query (allowing among other things to make the query parameterisable)

• orderby: String - Sorting algorithm (SQL syntax)

• since

  Status
  title 11.10

  sortbyrelevance: Boolean - (Relevant only if query is fulltext) Indicate if results are sorted first by relevance (true) or not (false). Default to true

• since

  Status
  title 11.10

  sortbyrelevanceiforderby: Boolean - (Relevant only if query is fulltext) this property allows to deactivate sorting by relevance if an order by clause is configured. If this property is false, sortbyrelevance must be explicity to true to get result sorted by relevance if there is an order by set. Default to true.

• Secured: Boolean - Indicate if we apply (true) or not (false) the security. Default to true

• max: Integer - The maximum number of instance to export at each call (page size)

• from: Integer - The index of the first instance to get (0 based index)

• fulltext: String - A text based search criteria

• props: Array of Strings - defines attributes that should be retrieved
  It is possible to export the properties of a linked object by adding a ‘.’ between the name of the property and the property name of the related object.
  E.g. for the name of the object, the status name of the object, and the status color code: [“name”, “status.name”, “status.color.name”].

• aggs: Object<String, Object<String, Array of Strings>Aggregates section

  • Keys represent attributes on which aggregation informations should be computed. Array<String> represents list of properties that should be gathered for each aggregation result.

• header: allows to add custom information regarding the service

• Status
  title

  since

  11.18

  queryPolicies: object - allows you to manage rights on the requestable fields

• Status
  title

  since

  11.18

  queryPoliciesByRoles: Object<string, object> - allows you to manage rights on the requestable fields, depending of role of the surfer

...

• To get a view

• To get the list of available views

EndPoint: Get a view

GET http://host:port/app/api/json/view/{viewName}{/id}

HEAD http://host:port/app/api/json/view/{viewName}{/id}

since

GET http://host:port/app/api/json/view

...

• viewName: String - View identifier

• props: String - Comma separated names and properties (only properties available in the view can be requested, if blank all properties will be displayed)

• query: String - A selection request following JSON type specific language (to combine with the configured request). For long requests (above URL maximum length), request can be defined in the header X-WEDIA-QUERY, or in the body of the request (supported content types: application/json, text/json)).

• orderby - String (SQL syntax): Sorting algorithm

• since

  Status
  title 11.10

  sortbyrelevance: Boolean - Overrides sortbyrelevance from configuration

• secured: boolean - To apply or not the security (if configuration is applied, then security must be applied)

• fulltext: String - The text based search criteria

• from: Integer - Number of the first requested object

• max: Integer - Maximum number of the requested objects

• rawValues Boolean - Indicates if we apply the localization (false by default)

• headers: Boolean - Indicates if headers are required (Cf. hereafter, response format) (false by default)

• aggHeaders: Boolean - Indicates if aggregates headers are separated from or mixed with properties headers (true by default)

• Status
  title

  since

  11.10.2

  id (or form_id): String - single resource query (without aggregates)

...

EndPoint: list of available views

GET http//host:port/app/api/json/catalog/view

...