Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

InterfacePreviews.get

Returns interfacepreview with given id

Input

type: object properties: parameters: type: object properties: id: type: string format: uuid description: ID of interfacepreview 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 - has_draft - id - charts - detail_tabs - detail_widgets - field_ids - entity_type_id - entity_type 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 has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published 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 account_type: type: string format: uri description: >- Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties. appointment_type: type: string format: uri description: >- Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. contact_type: type: string format: uri description: >- Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties. lead_type: type: string format: uri description: >- Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. oppty_type: type: string format: uri description: >- Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. project_type: type: string format: uri description: >- Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties. quote_type: type: string format: uri description: >- Relation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties. task_type: type: string format: uri description: >- Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties. account_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true appointment_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true charts: type: object description: Field containing json. contact_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true detail_tabs: type: object description: Field containing json. detail_widgets: type: object description: Field containing json. field_ids: type: object description: '' lead_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true project_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true quote_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true task_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true is_published: type: boolean example: false description: '' readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. entity_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: '' readOnly: true entity_type: type: integer description: >- Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 type: object