CustomEntities.get

Returns CustomEntity with given id

Responses

🟢200OK

application/json

CustomEntity data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (CustomEntity)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

currency_exchange_rates_list

string <uri>

optional

Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

type

string <uri>

required

Relation to CustomEntityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityType' object for properties.

unit

string <uri>

required

Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

name

string

optional

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

table_name

string

read-onlyrequired

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

documents

array[string <uri>]

optional

Relations to CloudObjects.

static_profiles

array[string <uri>]

optional

Relations to Profiles.

is_favorite

boolean

required

Example:

false

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "currency_exchange_rates_list": "http://example.com",
        "owner": "http://example.com",
        "type": "http://example.com",
        "unit": "http://example.com",
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "share_mode": 0,
        "table_name": "string",
        "type_id": "01234567-abcd-dcba-ffff-000000000000",
        "unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "sharing_units": [
            "http://example.com"
        ],
        "sharing_clients": [
            "http://example.com"
        ],
        "documents": [
            "http://example.com"
        ],
        "static_profiles": [
            "http://example.com"
        ],
        "is_favorite": false,
        "revision": 1
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses