Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

Targets.create

Creates new target

Input

type: object properties: parameters: type: object properties: validation-level: type: integer format: int32 description: >- Specify validation level of target on create. 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. title: Parameters data: required: - is_active - name - owner_id properties: 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 calculation_type: type: integer description: 'Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated' example: 1 enum: - 1 - 2 - 3 description: type: string example: string description: Multi-line text input field. is_active: type: boolean example: false description: Boolean value. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. period_from: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Date information. period_to: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Date information. target_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. type: type: integer description: 'Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting' example: 1 enum: - 1 - 2 - 3 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. child_targets: type: array description: Relations to Targets. items: type: object description: >- Relation to TargetRelation, see: 'createTargetRelationInput' 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 - is_active - name - owner_id - settings 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 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. target_client: 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. calculation_type: type: integer description: 'Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated' example: 1 enum: - 1 - 2 - 3 description: type: string example: string description: Multi-line text input field. is_active: type: boolean example: false description: Boolean value. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. period_from: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Date information. period_to: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Date information. settings: type: string format: binary example: blob description: '' target_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. type: type: integer description: 'Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting' example: 1 enum: - 1 - 2 - 3 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. child_targets: type: array description: Relations to Targets. items: type: string format: uri description: >- Relation to TargetRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TargetRelation' object for properties. type: object