Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

FormViews.update

Modifies formview or FormViews with given id(s)

Input

type: object properties: parameters: type: object properties: id: type: string format: uuid description: ID of formview to update validation-level: type: integer format: int32 description: >- Specify validation level of formview on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship. required: - id title: Parameters data: properties: account_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. contact_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. hidden_item_ids: type: object description: Ids of fields hidden on the form item_colors: type: object description: Field containing json. lead_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. name: type: string example: string description: Name of the entity and its default text representation. oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. share_mode: type: integer description: 'Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers' example: 0 enum: - 0 - 1 - 2 use_lang: type: boolean example: false description: Boolean value. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_clients: type: array description: '' items: type: object description: 'Relation to Client, see: ''updateClientInput'' object for properties.' properties: id: type: string format: uri sharing_units: type: array description: '' items: type: object description: >- Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties. properties: id: type: string format: uri type: object title: Data

Output

type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: required: - is_delete_protected - id - owner - hidden_item_ids - item_colors - name - owner_id - entity_type_id 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 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. 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. 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. account_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. contact_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. hidden_item_ids: type: object description: Ids of fields hidden on the form item_colors: type: object description: Field containing json. lead_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. name: type: string example: string description: Name of the entity and its default text representation. oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. share_mode: type: integer description: 'Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers' example: 0 enum: - 0 - 1 - 2 use_lang: type: boolean example: false description: Boolean value. 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: '' sharing_clients: type: array description: '' items: 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. sharing_units: type: array description: '' items: type: string format: uri description: >- Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. type: object