OpportunityTypes.get

Returns OpportunityType with given id

Responses

🟢200OK

application/json

OpportunityType data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (OpportunityType)

optional

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

pipeline

string <uri>

required

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

form_edit

object

optional

Form definition in json format.

form_lost

object

optional

Form definition in json format.

form_qualify

object

optional

Form derived definition in json format.

form_won

object

optional

Form derived definition in json format.

is_readonly

boolean

required

Boolean value.

Example:

false

name

string

required

Name of the entity and its default text representation.

Example:

string

pipeline_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

settings

string <binary>

required

Example:

blob

is_published

boolean

read-onlyoptional

Example:

false

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

has_draft

boolean

required

Set to True if draft for entity exists and can be published

Example:

false

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

form_edit_api

object

required

Form definition in json format.

can_change_readonly

boolean

optional

Returns if user can change readonly flag on this entity_type.

Example:

false

form_lost_api

object

required

Form definition in json format.

form_qualify_api

array [object]

required

Form derived definition in json format.

form_won_api

array [object]

required

Form derived definition in json format.

Example

{
    "success": true,
    "data": {
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "pipeline": "http://example.com",
        "form_edit": {},
        "form_lost": {},
        "form_qualify": {},
        "form_won": {},
        "is_readonly": false,
        "name": "string",
        "pipeline_id": "01234567-abcd-dcba-ffff-000000000000",
        "settings": "blob",
        "is_published": false,
        "revision": 1,
        "has_draft": false,
        "is_delete_protected": false,
        "form_edit_api": {},
        "can_change_readonly": false,
        "form_lost_api": {},
        "form_qualify_api": [
            {}
        ],
        "form_won_api": [
            {}
        ]
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses