LeadProcesses.get

Returns LeadProcess with given id

Responses

🟢200OK

application/json

LeadProcess data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (LeadProcess)

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

color

integer <int32>

optional

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

Example:

name

string

required

Name of the entity and its default text representation.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

steps

array[object (batchStepInput) {13}]

required

lead_types

array[string <uri>]

required

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",
        "color": 1,
        "name": "string",
        "revision": 1,
        "steps": [
            {
                "description": "string",
                "has_readonly_form": false,
                "has_version_increment": false,
                "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
                "name": "string",
                "percent": 1,
                "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
                "sort_order": 1,
                "timeframe": 1,
                "revision": 1,
                "documents": [
                    {
                        "id": "http://example.com"
                    }
                ],
                "step_checklists": [
                    {
                        "id": "http://example.com"
                    }
                ],
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            }
        ],
        "lead_types": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses