ad4929e48b
* Turkish language created for Docs. Belgeler için türkçe dil desteği oluşturuldu. * Turkish docs fix
2.6 KiB
2.6 KiB
REST API
NocoBase's HTTP API is a superset of the REST API, and the standard CRUD API also supports the RESTful style.
Collection resources
Create collection
HTTP API
POST /api/<collection>:create
{} # JSON body
REST API
POST /api/<collection>
{} # JSON body
List collection
HTTP API
GET /api/<collection>:list
REST API
GET /api/<collection>
View collection details
HTTP API
GET /api/<collection>:get?filterByTk=<collectionIndex>
GET /api/<collection>:get/<collectionIndex>
REST API
GET /api/<collection>/<collectionIndex>
Update collection
HTTP API
POST /api/<collection>:update?filterByTk=<collectionIndex>
{} # JSON body
# Or
POST /api/<collection>:update/<collectionIndex>
{} # JSON body
REST API
PUT /api/<collection>/<collectionIndex>
{} # JSON body
Delete collection
HTTP API
POST /api/<collection>:destroy?filterByTk=<collectionIndex>
# Or
POST /api/<collection>:destroy/<collectionIndex>
REST API
DELETE /api/<collection>/<collectionIndex>
Association resources
Create Association
HTTP API
POST /api/<collection>/<collectionIndex>/<association>:create
{} # JSON body
REST API
POST /api/<collection>/<collectionIndex>/<association>
{} # JSON body
List Association
HTTP API
GET /api/<collection>/<collectionIndex>/<association>:list
REST API
GET /api/<collection>/<collectionIndex>/<association>
View Association details
HTTP API
GET /api/<collection>/<collectionIndex>/<association>:get?filterByTk=<associationIndex>
# Or
GET /api/<collection>/<collectionIndex>/<association>:get/<associationIndex>
REST API
GET /api/<collection>/<collectionIndex>/<association>:get/<associationIndex>
Update Association
HTTP API
POST /api/<collection>/<collectionIndex>/<association>:update?filterByTk=<associationIndex>
{} # JSON body
# Or
POST /api/<collection>/<collectionIndex>/<association>:update/<associationIndex>
{} # JSON body
REST API
PUT /api/<collection>/<collectionIndex>/<association>:update/<associationIndex>
{} # JSON
Delete Association
HTTP API
POST /api/<collection>/<collectionIndex>/<association>:destroy?filterByTk=<associationIndex>
# Or
POST /api/<collection>/<collectionIndex>/<association>:destroy/<associationIndex>
REST API
DELETE /api/<collection>/<collectionIndex>/<association>/<associationIndex>