OpenVeo Publish server

API Docs for: 8.0.0
Show:

PropertyController

Extends EntityController
Defined in: app/server/controllers/PropertyController.js:14
Module: controllers

Summary

Defines a controller to handle actions relative to properties' routes.

Constructor

PropertyController

Defined in app/server/controllers/PropertyController.js:14

Syntax

PropertyController

()

Summary

Methods

getEntitiesAction

Defined in app/server/controllers/PropertyController.js:43

Syntax

getEntitiesAction

(
  • request
  • response
  • next
)
async

Summary

Gets custom properties.

Parameters:

  • request Request

    ExpressJS HTTP Request

    • [query] Object optional

      Request's query

      • [include] String | Array optional
        The list of fields to include from returned properties
      • [exclude] String | Array optional
        The list of fields to exclude from returned properties. Ignored if include is also specified.
      • [query] String optional
        Search query to search on both name and description
      • [types] Array optional
        To filter properties by type
      • [page=0] String optional
        The expected page
      • [limit=10] String optional
        The expected limit
      • [sortBy="name"] String optional
        The field to sort properties by (either **name** or **description**)
      • [sortOrder="desc"] String optional
        The sort order (either **asc** or **desc**)
  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

Example:

// Response example
{
  "entities" : [ ... ],
  "pagination" : {
    "limit": ..., // The limit number of custom properties by page
    "page": ..., // The actual page
    "pages": ..., // The total number of pages
    "size": ... // The total number of custom properties
}

getPropertyTypesAction

Defined in app/server/controllers/PropertyController.js:28

Syntax

getPropertyTypesAction

(
  • request
  • response
  • next
)
async

Summary

Gets the list of custom property types.

Parameters:

  • request Request

    ExpressJS HTTP Request

  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

getProvider

Defined in app/server/controllers/PropertyController.js:128

Syntax

getProvider

() PropertyProvider

Summary

Gets associated provider.

Returns:

PropertyProvider:

The provider associated to the controller