Skip to main content

Dynamic Entity Endpoint

Configuration etc. is described in the following chapter: Configuration Documentation

GET read entity object​

This endpoint allows to retrieve an object of a configured entity by its configured ID.

URL : /foobar/:id

Method :

Auth required : Configurable

Permissions required : No

Route parameter : id

Ex. /foobar/1231233

Success Response​

Condition : If entity object is found.

Code : 200 OK

Content example

{
  "foobar": "barfoo",
  "barfoo": "foobar"
}

or

Condition : no object is found. Empty entity is returned.

Content example

{
  "foobar": "",
  "barfoo": ""
}

GET read Collection​

This endpoint allows to get a collection of a configured entity.

URL : /foobar

Method :

Auth required : Configurable

Permissions required : No

Query parameters : Default filters, OrderBy

Ex. /foobar?intPageIndex=124&intPageSize=50&intMaxRows=10000&OrderBy=+foobar

Success Response​

Condition : If entity collection is found.

Code : 200 OK

Content example

{
  "perPage": 50,
  "lastPage": "120",
  "currentPage": "1",
  "total": 5984,
  "data": [
    {
      "foobar": "barfoo1",
      "barfoo": "foobar1"
    },
    {
      "foobar": "barfoo2",
      "barfoo": "foobar2"
    }
  ]
}

or

Condition : no entities are found.

Content example

{
  "perPage": 50,
  "lastPage": "120",
  "currentPage": "124",
  "total": 5984,
  "data": []
}

POST create Entity object​

An entity can be created with this endpoint. The endpoint must be configured accordingly.

URL : /foobar

Method :

Auth required : Configurable

Permissions required : None

Body parameters

The params have to be sent as form-data with the following params. The primary key shall be empty in this case.

{
  "foobar": "barfoo3",
  "barfoo": "foobar3"
}

Success Response​

Condition : If the object was successfully created.

Code : 200 OK

Content example

{
  "foobar": "barfoo3",
  "barfoo": "foobar3"
}

Error Responses​

Condition : if there was an error during creation

Code : 404 NOT FOUND

PUT update entity object​

An entity can be modified with this endpoint. The endpoint must be configured accordingly.

URL : /foobar/:id

Method :

Auth required : Configurable

Permissions required : None

Route parameter : id

The params have to be sent as form-data with the following params. The primary key of the entity has to match the route parameter.

URL : /foobar/barfoo3

{
  "foobar": "barfoo3",
  "barfoo": "foobar333"
}

Success Response​

Condition : If the object was modified successfully.

Code : 200 OK

Content example

{
  "foobar": "barfoo3",
  "barfoo": "foobar333"
}

Error Responses​

Condition : if there was an error during creation

Code : 404 NOT FOUND

DELETE delete entity object​

An entity can be deleted with this endpoint. The endpoint must be configured accordingly.

URL : /foobar/:id

Method :

Auth required : Configurable

Permissions required : None

Route parameter : id

The route parameter specifies the value of the primary key of the entity to be deleted.

URL : /foobar/barfoo3

Success Response​

Condition : If the object was deleted successfully.

Code : 200 OK

Error Responses​

Condition : if there was an error during creation

Code : 404 NOT FOUND