Chinese Documentation : Application REST API

All of the endpoints in the Application REST API are inherited from the PersistedModel REST API.  The reference is provided here for convenience.

Quick reference

URI Pattern

HTTP VerbDefault PermissionDescriptionArguments

/applications

 

POSTAllow

Add application instance and persist to data source. Inherited from generic model API.

JSON object (in request body)
/applicationsGETDenyFind all instances of applications that match specified filter. Inherited from generic model API .

One or more filters in query parameters:

  • where
  • include
  • order
  • limit
  • skip / offset
  • fields
/applicationsPUTDenyUpdate / insert application instance and persist to data source. Inherited from generic model API .JSON object (in request body)
/applications/idGETDenyFind applications by ID: Return data for the specified applications instance ID. Inherited from generic model API .id, the application instance ID (in URI path)
/applications/idPUTDenyUpdate attributes for specified applications ID and persist. Inherited from generic model API .

Query parameters:

  • data - An object containing property name/value pairs
  • id - The model id
/applications/idDELETEDenyDelete application with specified instance ID. Inherited from generic model API .id, application ID (in URI path)
/applications/id/existsGETDeny

Check instance existence: Return true if specified application ID exists. Inherited from generic model API .

URI path:

  • id - Model instance ID
/applications/countGETDeny

Return the number of application instances that matches specified where clause. Inherited from generic model API.

Where filter specified in query parameter
/applications/findOneGETDeny

Find first application instance that matches specified filter. Inherited from generic model API .

Same as Find matching instances.