Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

CustomEntityRelations.update

Modifies customentityrelation or CustomEntityRelations with given id(s)

Input

type: object properties: parameters: type: object properties: id: type: string format: uuid description: ID of customentityrelation to update validation-level: type: integer format: int32 description: >- Specify validation level of customentityrelation 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: entity_filter_1: type: object description: Field containing json. entity_filter_2: type: object description: Field containing json. field_1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. field_2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. show_related_1: type: boolean example: false description: Boolean value. show_related_2: type: boolean example: false description: Boolean value. show_tab_1: type: boolean example: false description: Boolean value. show_tab_2: type: boolean example: false description: Boolean value. tab_name_1: type: string example: string description: String value. tab_name_2: type: string example: string description: String value. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. 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 - has_draft - id - field_1 - field_2 - field_1_id - field_2_id - show_tab_1 - show_tab_2 - tab_name_1 - tab_name_2 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 field_1: type: string format: uri description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. field_2: type: string format: uri description: >- Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. entity_filter_1: type: object description: Field containing json. entity_filter_2: type: object description: Field containing json. field_1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. field_2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. show_related_1: type: boolean example: false description: Boolean value. show_related_2: type: boolean example: false description: Boolean value. show_tab_1: type: boolean example: false description: Boolean value. show_tab_2: type: boolean example: false description: Boolean value. tab_name_1: type: string example: string description: String value. tab_name_2: type: string example: string description: String value. is_published: type: boolean example: false description: '' readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. type: object