EntityFitnessIndicators.get

Returns EntityFitnessIndicator with given id

Responses

🟢200OK

application/json

EntityFitnessIndicator data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (EntityFitnessIndicator)

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

entity_fitness

string <uri>

required

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

description

string

required

String value.

Example:

string

description_use_lang

boolean

required

Boolean value.

Example:

false

entity_fitness_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

how_to_fix

string

required

String value.

Example:

string

how_to_fix_use_lang

boolean

required

Boolean value.

Example:

false

is_enabled

boolean

required

Boolean value.

Example:

false

name

string

required

String value.

Example:

string

name_use_lang

boolean

required

Boolean value.

Example:

false

settings

string <binary>

required

Example:

blob

type

enum<integer>

required

Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease

Allowed values:

123456789101112

Example:

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",
        "entity_fitness": "http://example.com",
        "description": "string",
        "description_use_lang": false,
        "entity_fitness_id": "01234567-abcd-dcba-ffff-000000000000",
        "how_to_fix": "string",
        "how_to_fix_use_lang": false,
        "is_enabled": false,
        "name": "string",
        "name_use_lang": false,
        "settings": "blob",
        "type": 1,
        "revision": 1
    }
}

🟠404Record Not Found

🔴500Server Error

EntityFitnessIndicators.get

Request

Request samples

Responses