Entities API

All requests for this API must be authenticated. The authentication can be achieved in the following ways:

  1. by using and API Key
  2. by using the Auth API
  3. by using the Oauth2 flow
  4. by using the OpenID flow

GET /rest/entity/{name}/{key}

Retrieve an entity.

Request

GET /rest/entity/{name}/{key}

NameTypeDescription
namestringThe name of the entity to retrieve
keylongThe key of the entity ro retrieve

Response

200 Ok

The operation was successful, the result will be similar to this:

{
    "entity_name": "the_name",
    "properties": {
        "key": 1,
        "a_property": "value"
    },
    "children": {
        "the_name_the_items": [
            "entity_name": "the_items",
            "properties": {
                "key": 10,
                "other_property": 10
            }
        ]
    }
}
400 Bad Request

There was an error deserializing the JSON message.

{
    "detail": "error detail"
}
401 Unauthorized

The operation is not authorized.

Check if the authentication cookie is set or valid or a valid username and password are set in the URL.

500 Internal Error

All errors except for JSON message deserialization errors.

{
    "detail": "error detail"
}

cURL Example

Read a catalog entity

Given the following cURL request:

curl --header "X-API-Key: e3097afe-1528-4fdb-a816-0d3724a8f318" \
    --url "https://devdev17.oneerp.ro/rest/entity/ui_catalog/2"

The server will return the following response:

{
    "entity_name": "ui_catalog",
    "children": {"ui_catalog_ui_catalog_filter_owner": []},
    "properties": {
        "id_organization": 1,
        "date_updated": "2021-08-30T12:44:48.000+03:00",
        "date_created": "2021-04-06T15:25:46.000+03:00",
        "fetch": "FETCH wf(key, name AS value) ORDER BY key ASC",
        "name": "wfList",
        "value_property_name": "name",
        "id_business_unit": 2,
        "id_user": 3,
        "fetch_extended": "",
        "uuid": "a7a88683-bcd3-4da7-a9d9-77b26b662104",
        "key": 2,
        "extended": 0
    }
}

POST /rest/entity/{name}

Create an entity.

Request

ParameterTypeDescription
namestringThe name of the entity.
Headers and Payload
HeaderValueDescription
Content-Typeapplication/jsonThe content type.
X-CSRF-TokenThe value from the one.erp.csrf.token cookie.CSRF protection token.

The JSON payload:

{
    "entity_name": "the_name",
    "properties": {
        "a_property": "value"
    },
    "children": {
        "the_name_the_items": [
            "entity_name": "the_items",
            "properties": {
                "other_property": 10
            }
        ]
    }
}

Response

200 Ok

The operation was successful.

{
    "operation": "insert",
    "key": 10
}
400 Bad Request

There was an error deserializing the JSON message.

{
    "detail": "error detail"
}
424 Entity Validation Failed

There was a business rule validation failure.

{
	"eventName": "onBeforeInsert",
	"entityName": "invoice",
	"propertyName": "number",
	"childEntityName": "invoice_item",
	"childPropertyName": "price",
	"childEntityIndex": 1,
    "detail": "error detail"
}
401 Unauthorized

The operation is not authorized.

Check if the authentication cookie is set or valid or a valid username and password are set in the URL.

500 Internal Error

All errors except for JSON message deserialization errors.

{
    "detail": "error detail"
}

POST /rest/entity/{name}/{key}

Update an entity.

Request

ParameterTypeDescription
namestringThe name of the entity.
keylongThe key of the entity.
Headers and Payload
HeaderValueDescription
Content-Typeapplication/jsonThe content type.
X-CSRF-TokenThe value from the one.erp.csrf.token cookie.CSRF protection token.

The JSON payload:

{
    "entity_name": "the_name",
    "properties": {
        "key": 1,
        "a_property": "value"
    },
    "children": {
        "the_name_the_items": [
            "entity_name": "the_items",
            "properties": {
                "key": 10,
                "other_property": 10
            }
        ]
    }
}

Response

200 Ok

The operation was successful.

{
    "operation": "update",
    "key": 10
}
400 Bad Request

There was an error deserializing the JSON message.

{
    "detail": "error detail"
}
424 Entity Validation Failed

There was a business rule validation failure.

{
	"eventName": "onBeforeUpdate",
	"entityName": "invoice",
	"propertyName": "number",
	"childEntityName": "invoice_item",
	"childPropertyName": "price",
	"childEntityIndex": 1,
    "detail": "error detail"
}
401 Unauthorized

The operation is not authorized.

Check if the authentication cookie is set or valid or a valid username and password are set in the URL.

500 Internal Error

All errors except for JSON message deserialization errors.

{
    "detail": "error detail"
}

DELETE /rest/entity/{name}/{key}

Delete an entity.

ParameterTypeDescription
namestringThe name of the entity.
keylongThe key of the entity.
Headers
HeaderValueDescription
X-CSRF-TokenThe value from the one.erp.csrf.token cookie.CSRF protection token.

Empty payload.

Response

200 Ok The operation was successful.
400 Bad Request

There was an error deserializing the JSON message.

{
    "detail": "error detail"
}
424 Entity Validation Failed

There was a business rule validation failure.

{
	"eventName": "onBeforeDelete",
	"entityName": "invoice",
	"propertyName": "number",
	"childEntityName": "invoice_item",
	"childPropertyName": "price",
	"childEntityIndex": 1,
    "detail": "error detail"
}
401 Unauthorized

The operation is not authorized.

Check if the authentication cookie is set or valid or a valid username and password are set in the URL.

500 Internal Error

All errors except for JSON message deserialization errors.

{
    "detail": "error detail"
}
← Auth API
Fetch API →