Back to PipelinerProjects.create
Input
type: object
properties:
parameters:
type: object
properties:
validation-level:
type: integer
format: int32
description: >-
Specify validation level of project 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:
- end_date
- name
- owner_id
- revenue_goal
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
account_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
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.
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.
project_type_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: 0 - Standard, 1 - Private, 2 - AllView, 3 -
AllEdit
example: 0
enum:
- 0
- 1
- 2
- 3
start_date:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
revenue_goal:
type: object
required:
- base_value
- currency_id
- value_foreign
description: Monetary value in a foreign currency.
properties:
base_value:
type: number
format: double
example: '4.32'
description: Currency.
currency_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
value_foreign:
type: number
format: double
example: '4.32'
description: Decimal number.
documents:
type: array
description: Relations to CloudObjects.
items:
type: object
description: >-
Relation to CloudObjectRelation, see:
'createCloudObjectRelationInput' object for properties.
properties:
id:
type: string
format: uri
sharing_units:
type: array
description: Relations to SalesUnits.
items:
type: object
description: >-
Relation to ProjectSharingSalesUnitRelation, see:
'createProjectSharingSalesUnitRelationInput' object for properties.
properties:
id:
type: string
format: uri
sharing_clients:
type: array
description: Relations to Clients.
items:
type: object
description: >-
Relation to ProjectSharingClientRelation, see:
'createProjectSharingClientRelationInput' object for properties.
properties:
id:
type: string
format: uri
contact_relations:
type: array
description: Relations to Contacts.
items:
type: object
description: >-
Relation to ProjectContactRelation, see:
'createProjectContactRelationInput' object for properties.
properties:
id:
type: string
format: uri
tags:
type: array
description: Relations to Tags.
items:
type: object
description: >-
Relation to TagRelation, see: 'createTagRelationInput' 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
- project_type
- unit
- end_date
- name
- owner_id
- revenue_goal
- is_favorite
- status
- formatted_name
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: string
format: uri
description: >-
Relation to Account. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Account' 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.
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.
unit:
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.
account_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
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.
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.
project_type_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: 0 - Standard, 1 - Private, 2 - AllView, 3 -
AllEdit
example: 0
enum:
- 0
- 1
- 2
- 3
start_date:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
revenue_goal:
type: object
required:
- base_value
- currency_id
- value_foreign
description: Monetary value in a foreign currency.
properties:
base_value:
type: number
format: double
example: '4.32'
description: Currency.
currency_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
value_foreign:
type: number
format: double
example: '4.32'
description: Decimal number.
documents:
type: array
description: Relations to CloudObjects.
items:
type: string
format: uri
description: >-
Relation to CloudObjectRelation. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'CloudObjectRelation' object for properties.
sharing_units:
type: array
description: Relations to SalesUnits.
items:
type: string
format: uri
description: >-
Relation to ProjectSharingSalesUnitRelation. By default it is
returned as URI to related resource. Using parameter 'expand', it
will return full entity. See: 'ProjectSharingSalesUnitRelation'
object for properties.
sharing_clients:
type: array
description: Relations to Clients.
items:
type: string
format: uri
description: >-
Relation to ProjectSharingClientRelation. By default it is returned
as URI to related resource. Using parameter 'expand', it will return
full entity. See: 'ProjectSharingClientRelation' object for
properties.
primary_contact:
type: string
format: uri
description: >-
Relation to Contact. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Contact' object for properties.
contact_relations:
type: array
description: Relations to Contacts.
items:
type: string
format: uri
description: >-
Relation to ProjectContactRelation. By default it is returned as URI
to related resource. Using parameter 'expand', it will return full
entity. See: 'ProjectContactRelation' object for properties.
tags:
type: array
description: Relations to Tags.
items:
type: string
format: uri
description: >-
Relation to TagRelation. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'TagRelation' object for properties.
objectives:
type: array
description: ''
items:
type: string
format: uri
description: >-
Relation to ProjectObjective. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ProjectObjective' object for properties.
is_favorite:
type: boolean
example: false
description: ''
status:
type: integer
description: 'Integer enum value: 1 - NotStarted, 2 - InProgress, 4 - Completed'
example: 1
enum:
- 1
- 2
- 4
completion_rate:
type: number
format: double
example: '4.32'
description: ''
activities_total:
type: number
format: double
example: '4.32'
description: ''
activities_completed:
type: number
format: double
example: '4.32'
description: ''
formatted_name:
type: string
example: string
description: ''
modified_by_user:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: ''
type: object