Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

Forecasts.create

Creates new forecast

Input

type: object properties: parameters: type: object properties: validation-level: type: integer format: int32 description: >- Specify validation level of forecast 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: - name - owner_id - settings - shared_clients - shared_units 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 description: type: string example: string description: Multi-line text input field. 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. settings: type: object description: Field containing json. share_mode: type: integer description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit example: 0 enum: - 0 - 1 - 2 - 3 share_mode_params: type: string example: 1 enum: - 1 - 2 description: |- Bit Flag field, with limited combination of integer values. Options: ShareToUnitManagers = 1 (0b01) ShareToIncludedUsers = 2 (0b10) revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. shared_clients: type: array description: '' items: type: object description: 'Relation to Client, see: ''createClientInput'' object for properties.' properties: id: type: string format: uri shared_units: type: array description: '' items: type: object description: >- Relation to SalesUnit, see: 'createSalesUnitInput' 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 - field - owner - pipeline - end_date - field_id - name - owner_id - pipeline_id - settings - start_date - type - shared_clients - shared_units 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 field: 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. 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. pipeline: type: string format: uri description: >- Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties. readOnly: true description: type: string example: string description: Multi-line text input field. end_date: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Date information. readOnly: true field_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true 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. pipeline_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. readOnly: true settings: type: object description: Field containing json. share_mode: type: integer description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit example: 0 enum: - 0 - 1 - 2 - 3 share_mode_params: type: string example: 1 enum: - 1 - 2 description: |- Bit Flag field, with limited combination of integer values. Options: ShareToUnitManagers = 1 (0b01) ShareToIncludedUsers = 2 (0b10) start_date: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Date information. readOnly: true type: type: object description: Field containing json. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. shared_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. shared_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