Back to PipelinerClientStoryReads.get
Returns clientstoryread with given id
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
format: uuid
description: ID of clientstoryread to retrieve
required:
- id
title: Parameters
Output
type: object
properties:
success:
type: boolean
example: true
description: True when response succeeded, false on error.
data:
required:
- is_delete_protected
- id
- owner
- owner_id
- read_at
properties:
is_delete_protected:
type: boolean
example: false
description: >-
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.
readOnly: true
id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Unique identifier of entity.
readOnly: true
is_deleted:
type: boolean
example: false
description: Specifies if the entity is considered deleted.
readOnly: true
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
readOnly: true
appointment:
type: string
format: uri
description: >-
Relation to Appointment. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Appointment' object for properties.
task:
type: string
format: uri
description: >-
Relation to Task. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Task' object for properties.
email:
type: string
format: uri
description: >-
Relation to Email. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Email' object for properties.
memo:
type: string
format: uri
description: >-
Relation to Memo. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Memo' object for properties.
owner:
type: string
format: uri
description: >-
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.
activity_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty
message_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty
no_follow:
type: boolean
example: false
description: Boolean value.
owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
read_at:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
type: object