openapi: 3.2.0 info: title: Pipeliner Cloud Project API version: '100' servers: - url: https://us-east.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://eu-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ca-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ap-southeast.api.pipelinersales.com/api/v100/rest/spaces/{space_id} tags: - name: Project paths: /entities/Projects/{id}: get: description: Returns Project with given id operationId: Projects.get summary: Projects.get tags: - Project parameters: - name: id in: path description: ID of Project to retrieve required: true schema: type: string format: uuid responses: '200': description: Project data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Project' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes Project with given id operationId: Projects.delete summary: Projects.delete tags: - Project parameters: - name: id in: path description: ID of Project to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Project on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted Project type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies Project or Projects with given id(s) parameters: - name: id in: path description: ID of Project to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Project 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.' schema: type: integer format: int32 operationId: Projects.update summary: Projects.update tags: - Project requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectInput' responses: '200': description: Modification confirmation. Returns resulting Project content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Project' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Projects: get: description: Returns all defined Projects operationId: Projects.list summary: Projects.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted Projects are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Projects content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/Project' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new Project operationId: Projects.create summary: Projects.create tags: - Project parameters: - name: validation-level in: query 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.' schema: type: integer format: int32 requestBody: description: data of new Project required: true content: application / json: schema: $ref: '#/components/schemas/createProjectInput' responses: '201': description: Creation confirmation. Returns created Project content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Project' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Projects/batch-delete: post: description: Removes Projects with given list of ids operationId: Projects.batch_delete summary: Projects.batch_delete tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of Projects on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity Project to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted Project. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Projects/batch-modify: post: description: Create or update an batch of Projects operationId: Projects.batch_create_or_update summary: Projects.batch_create_or_update tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of Projects on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new Project required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchProjectInput' responses: '200': description: Creation confirmation. Returns a list of created / updated Projects content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Projects/batch-restore: post: description: Restores Projects with given list of ids operationId: Projects.batch_restore summary: Projects.batch_restore tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of Projects on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity Project to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored Project. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectContactRelations/{id}: get: description: Returns ProjectContactRelation with given id operationId: ProjectContactRelations.get summary: ProjectContactRelations.get tags: - Project parameters: - name: id in: path description: ID of ProjectContactRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ProjectContactRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectContactRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes ProjectContactRelation with given id operationId: ProjectContactRelations.delete summary: ProjectContactRelations.delete tags: - Project parameters: - name: id in: path description: ID of ProjectContactRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectContactRelation on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted ProjectContactRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies ProjectContactRelation or ProjectContactRelations with given id(s) parameters: - name: id in: path description: ID of ProjectContactRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectContactRelation 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.' schema: type: integer format: int32 operationId: ProjectContactRelations.update summary: ProjectContactRelations.update tags: - Project requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting ProjectContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectContactRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectContactRelations: get: description: Returns all defined ProjectContactRelations operationId: ProjectContactRelations.list summary: ProjectContactRelations.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted ProjectContactRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectContactRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ProjectContactRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new ProjectContactRelation operationId: ProjectContactRelations.create summary: ProjectContactRelations.create tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectContactRelation 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.' schema: type: integer format: int32 requestBody: description: data of new ProjectContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createProjectContactRelationInput' responses: '201': description: Creation confirmation. Returns created ProjectContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectContactRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectContactRelations/batch-delete: post: description: Removes ProjectContactRelations with given list of ids operationId: ProjectContactRelations.batch_delete summary: ProjectContactRelations.batch_delete tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectContactRelations on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectContactRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted ProjectContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectContactRelations/batch-modify: post: description: Create or update an batch of ProjectContactRelations operationId: ProjectContactRelations.batch_create_or_update summary: ProjectContactRelations.batch_create_or_update tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectContactRelations on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ProjectContactRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchProjectContactRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ProjectContactRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectContactRelations/batch-restore: post: description: Restores ProjectContactRelations with given list of ids operationId: ProjectContactRelations.batch_restore summary: ProjectContactRelations.batch_restore tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectContactRelations on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectContactRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored ProjectContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectDataExRelations/{id}: get: description: Returns ProjectDataExRelation with given id operationId: ProjectDataExRelations.get summary: ProjectDataExRelations.get tags: - Project parameters: - name: id in: path description: ID of ProjectDataExRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ProjectDataExRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectDataExRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectDataExRelations: get: description: Returns all defined ProjectDataExRelations operationId: ProjectDataExRelations.list summary: ProjectDataExRelations.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted ProjectDataExRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectDataExRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ProjectDataExRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectKPIs/{id}: get: description: Returns ProjectKPI with given id operationId: ProjectKPIs.get summary: ProjectKPIs.get tags: - Project parameters: - name: id in: path description: ID of ProjectKPI to retrieve required: true schema: type: string format: uuid responses: '200': description: ProjectKPI data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectKPI' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes ProjectKPI with given id operationId: ProjectKPIs.delete summary: ProjectKPIs.delete tags: - Project parameters: - name: id in: path description: ID of ProjectKPI to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectKPI on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted ProjectKPI type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies ProjectKPI or ProjectKPIs with given id(s) parameters: - name: id in: path description: ID of ProjectKPI to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectKPI 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.' schema: type: integer format: int32 operationId: ProjectKPIs.update summary: ProjectKPIs.update tags: - Project requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectKPIInput' responses: '200': description: Modification confirmation. Returns resulting ProjectKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectKPI' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectKPIs: get: description: Returns all defined ProjectKPIs operationId: ProjectKPIs.list summary: ProjectKPIs.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted ProjectKPIs are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectKPIs content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ProjectKPI' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new ProjectKPI operationId: ProjectKPIs.create summary: ProjectKPIs.create tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectKPI 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.' schema: type: integer format: int32 requestBody: description: data of new ProjectKPI required: true content: application / json: schema: $ref: '#/components/schemas/createProjectKPIInput' responses: '201': description: Creation confirmation. Returns created ProjectKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectKPI' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectKPIs/batch-delete: post: description: Removes ProjectKPIs with given list of ids operationId: ProjectKPIs.batch_delete summary: ProjectKPIs.batch_delete tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectKPIs on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectKPI to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted ProjectKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectKPIs/batch-modify: post: description: Create or update an batch of ProjectKPIs operationId: ProjectKPIs.batch_create_or_update summary: ProjectKPIs.batch_create_or_update tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectKPIs on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ProjectKPI required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchProjectKPIInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ProjectKPIs content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectKPIs/batch-restore: post: description: Restores ProjectKPIs with given list of ids operationId: ProjectKPIs.batch_restore summary: ProjectKPIs.batch_restore tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectKPIs on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectKPI to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored ProjectKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectObjectives/{id}: get: description: Returns ProjectObjective with given id operationId: ProjectObjectives.get summary: ProjectObjectives.get tags: - Project parameters: - name: id in: path description: ID of ProjectObjective to retrieve required: true schema: type: string format: uuid responses: '200': description: ProjectObjective data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectObjective' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes ProjectObjective with given id operationId: ProjectObjectives.delete summary: ProjectObjectives.delete tags: - Project parameters: - name: id in: path description: ID of ProjectObjective to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectObjective on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted ProjectObjective type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies ProjectObjective or ProjectObjectives with given id(s) parameters: - name: id in: path description: ID of ProjectObjective to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectObjective 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.' schema: type: integer format: int32 operationId: ProjectObjectives.update summary: ProjectObjectives.update tags: - Project requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectObjectiveInput' responses: '200': description: Modification confirmation. Returns resulting ProjectObjective content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectObjective' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectObjectives: get: description: Returns all defined ProjectObjectives operationId: ProjectObjectives.list summary: ProjectObjectives.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted ProjectObjectives are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectObjectives content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ProjectObjective' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new ProjectObjective operationId: ProjectObjectives.create summary: ProjectObjectives.create tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectObjective 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.' schema: type: integer format: int32 requestBody: description: data of new ProjectObjective required: true content: application / json: schema: $ref: '#/components/schemas/createProjectObjectiveInput' responses: '201': description: Creation confirmation. Returns created ProjectObjective content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectObjective' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectObjectives/batch-delete: post: description: Removes ProjectObjectives with given list of ids operationId: ProjectObjectives.batch_delete summary: ProjectObjectives.batch_delete tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectObjectives on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectObjective to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted ProjectObjective. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectObjectives/batch-modify: post: description: Create or update an batch of ProjectObjectives operationId: ProjectObjectives.batch_create_or_update summary: ProjectObjectives.batch_create_or_update tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectObjectives on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ProjectObjective required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchProjectObjectiveInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ProjectObjectives content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectObjectives/batch-restore: post: description: Restores ProjectObjectives with given list of ids operationId: ProjectObjectives.batch_restore summary: ProjectObjectives.batch_restore tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectObjectives on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectObjective to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored ProjectObjective. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingClientRelations/{id}: get: description: Returns ProjectSharingClientRelation with given id operationId: ProjectSharingClientRelations.get summary: ProjectSharingClientRelations.get tags: - Project parameters: - name: id in: path description: ID of ProjectSharingClientRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ProjectSharingClientRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes ProjectSharingClientRelation with given id operationId: ProjectSharingClientRelations.delete summary: ProjectSharingClientRelations.delete tags: - Project parameters: - name: id in: path description: ID of ProjectSharingClientRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectSharingClientRelation on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted ProjectSharingClientRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies ProjectSharingClientRelation or ProjectSharingClientRelations with given id(s) parameters: - name: id in: path description: ID of ProjectSharingClientRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectSharingClientRelation 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.' schema: type: integer format: int32 operationId: ProjectSharingClientRelations.update summary: ProjectSharingClientRelations.update tags: - Project requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectSharingClientRelationInput' responses: '200': description: Modification confirmation. Returns resulting ProjectSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingClientRelations: get: description: Returns all defined ProjectSharingClientRelations operationId: ProjectSharingClientRelations.list summary: ProjectSharingClientRelations.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted ProjectSharingClientRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ProjectSharingClientRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new ProjectSharingClientRelation operationId: ProjectSharingClientRelations.create summary: ProjectSharingClientRelations.create tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingClientRelation 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.' schema: type: integer format: int32 requestBody: description: data of new ProjectSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createProjectSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created ProjectSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectSharingClientRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingClientRelations/batch-delete: post: description: Removes ProjectSharingClientRelations with given list of ids operationId: ProjectSharingClientRelations.batch_delete summary: ProjectSharingClientRelations.batch_delete tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingClientRelations on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectSharingClientRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted ProjectSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingClientRelations/batch-modify: post: description: Create or update an batch of ProjectSharingClientRelations operationId: ProjectSharingClientRelations.batch_create_or_update summary: ProjectSharingClientRelations.batch_create_or_update tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingClientRelations on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ProjectSharingClientRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchProjectSharingClientRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ProjectSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingClientRelations/batch-restore: post: description: Restores ProjectSharingClientRelations with given list of ids operationId: ProjectSharingClientRelations.batch_restore summary: ProjectSharingClientRelations.batch_restore tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingClientRelations on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectSharingClientRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored ProjectSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingSalesUnitRelations/{id}: get: description: Returns ProjectSharingSalesUnitRelation with given id operationId: ProjectSharingSalesUnitRelations.get summary: ProjectSharingSalesUnitRelations.get tags: - Project parameters: - name: id in: path description: ID of ProjectSharingSalesUnitRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: ProjectSharingSalesUnitRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes ProjectSharingSalesUnitRelation with given id operationId: ProjectSharingSalesUnitRelations.delete summary: ProjectSharingSalesUnitRelations.delete tags: - Project parameters: - name: id in: path description: ID of ProjectSharingSalesUnitRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectSharingSalesUnitRelation on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted ProjectSharingSalesUnitRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies ProjectSharingSalesUnitRelation or ProjectSharingSalesUnitRelations with given id(s) parameters: - name: id in: path description: ID of ProjectSharingSalesUnitRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectSharingSalesUnitRelation 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.' schema: type: integer format: int32 operationId: ProjectSharingSalesUnitRelations.update summary: ProjectSharingSalesUnitRelations.update tags: - Project requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectSharingSalesUnitRelationInput' responses: '200': description: Modification confirmation. Returns resulting ProjectSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingSalesUnitRelations: get: description: Returns all defined ProjectSharingSalesUnitRelations operationId: ProjectSharingSalesUnitRelations.list summary: ProjectSharingSalesUnitRelations.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted ProjectSharingSalesUnitRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new ProjectSharingSalesUnitRelation operationId: ProjectSharingSalesUnitRelations.create summary: ProjectSharingSalesUnitRelations.create tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingSalesUnitRelation 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.' schema: type: integer format: int32 requestBody: description: data of new ProjectSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createProjectSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created ProjectSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectSharingSalesUnitRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingSalesUnitRelations/batch-delete: post: description: Removes ProjectSharingSalesUnitRelations with given list of ids operationId: ProjectSharingSalesUnitRelations.batch_delete summary: ProjectSharingSalesUnitRelations.batch_delete tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingSalesUnitRelations on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectSharingSalesUnitRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted ProjectSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingSalesUnitRelations/batch-modify: post: description: Create or update an batch of ProjectSharingSalesUnitRelations operationId: ProjectSharingSalesUnitRelations.batch_create_or_update summary: ProjectSharingSalesUnitRelations.batch_create_or_update tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingSalesUnitRelations on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ProjectSharingSalesUnitRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchProjectSharingSalesUnitRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ProjectSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectSharingSalesUnitRelations/batch-restore: post: description: Restores ProjectSharingSalesUnitRelations with given list of ids operationId: ProjectSharingSalesUnitRelations.batch_restore summary: ProjectSharingSalesUnitRelations.batch_restore tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectSharingSalesUnitRelations on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectSharingSalesUnitRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored ProjectSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectTypes/{id}: get: description: Returns ProjectType with given id operationId: ProjectTypes.get summary: ProjectTypes.get tags: - Project parameters: - name: id in: path description: ID of ProjectType to retrieve required: true schema: type: string format: uuid responses: '200': description: ProjectType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes ProjectType with given id operationId: ProjectTypes.delete summary: ProjectTypes.delete tags: - Project parameters: - name: id in: path description: ID of ProjectType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectType on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted ProjectType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies ProjectType or ProjectTypes with given id(s) parameters: - name: id in: path description: ID of ProjectType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ProjectType 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.' schema: type: integer format: int32 operationId: ProjectTypes.update summary: ProjectTypes.update tags: - Project requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateProjectTypeInput' responses: '200': description: Modification confirmation. Returns resulting ProjectType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectTypes: get: description: Returns all defined ProjectTypes operationId: ProjectTypes.list summary: ProjectTypes.list tags: - Project parameters: - name: include-deleted in: query description: if enabled, deleted ProjectTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ProjectTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ProjectType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new ProjectType operationId: ProjectTypes.create summary: ProjectTypes.create tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectType 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.' schema: type: integer format: int32 requestBody: description: data of new ProjectType required: true content: application / json: schema: $ref: '#/components/schemas/createProjectTypeInput' responses: '201': description: Creation confirmation. Returns created ProjectType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ProjectType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectTypes/batch-delete: post: description: Removes ProjectTypes with given list of ids operationId: ProjectTypes.batch_delete summary: ProjectTypes.batch_delete tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectTypes on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted ProjectType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectTypes/batch-modify: post: description: Create or update an batch of ProjectTypes operationId: ProjectTypes.batch_create_or_update summary: ProjectTypes.batch_create_or_update tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectTypes on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ProjectType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchProjectTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ProjectTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ProjectTypes/batch-restore: post: description: Restores ProjectTypes with given list of ids operationId: ProjectTypes.batch_restore summary: ProjectTypes.batch_restore tags: - Project parameters: - name: validation-level in: query description: 'Specify validation level of ProjectTypes on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity ProjectType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored ProjectType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: updateProjectSharingSalesUnitRelationInput: properties: project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. ProjectObjective: 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true project: type: string format: uri description: 'Project this objective belongs to. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' name: type: string example: string description: Name of the entity and its default text representation. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. readOnly: true sort_order: type: integer format: int32 example: 1 description: Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - project - name - project_id - sort_order batchProjectObjectiveInput: properties: name: type: string example: string description: Name of the entity and its default text representation. sort_order: type: integer format: int32 example: 1 description: Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid ProjectContactRelation: 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true contact: type: string format: uri description: 'Contact linked to the project. 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.' project: type: string format: uri description: 'Project the contact is linked to. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - contact - project - contact_id - is_primary - project_id batchProjectSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createProjectObjectiveInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true name: type: string example: string description: Name of the entity and its default text representation. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. readOnly: true sort_order: type: integer format: int32 example: 1 description: Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - name - project_id - sort_order ProjectSharingSalesUnitRelation: 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true project: type: string format: uri description: 'Project being shared. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' unit: type: string format: uri description: 'Sales unit the project is shared with. 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.' project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - project - unit - project_id - unit_id createProjectContactRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - contact_id - is_primary - project_id Error: properties: http_status: description: HTTP status code type: integer example: 400 code: description: Internal API error code type: integer example: 117 name: description: Name of the API error type: string example: ERROR_PARAMETER_INVALID message: description: Description of the API error type: string success: description: Always false on error. type: boolean example: false required: - success - http_status ProjectType: properties: has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published 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 form_edit_api: type: object description: API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts. can_change_readonly: type: boolean example: false description: Returns if user can change readonly flag on this entity_type. 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing projects of this type. icon: type: integer description: 'Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). Integer enum value: 0 - GeneralIcon, 1 - Account' example: 0 enum: - 0 - 1 is_readonly: type: boolean example: false description: True when the project type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name - settings updateProjectSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchProjectInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the related account. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this project. description: type: string example: string description: Free-form description of the project. end_date: type: string format: date example: '2019-01-01' description: Planned end date of the project. Must be on or after start_date when both are set. 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: Id of the project owner. project_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project type. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). 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-01' description: Date when the project starts. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. revenue_goal: type: object 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. required: - base_value - currency_id - value_foreign description: Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this project. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectSharingSalesUnitRelation, see: ''updateProjectSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectSharingClientRelation, see: ''updateProjectSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this project. Editable only when share_mode allows user sharing. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectContactRelation, see: ''updateProjectContactRelationInput'' object for properties.' description: Contacts linked to this project, including the primary-contact flag. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this project. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this project currently matches. id: description: ID of object to update. type: string format: uuid updateProjectObjectiveInput: properties: name: type: string example: string description: Name of the entity and its default text representation. sort_order: type: integer format: int32 example: 1 description: Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateProjectTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing projects of this type. icon: type: integer description: 'Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). Integer enum value: 0 - GeneralIcon, 1 - Account' example: 0 enum: - 0 - 1 is_readonly: type: boolean example: false description: True when the project type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateProjectInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the related account. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this project. description: type: string example: string description: Free-form description of the project. end_date: type: string format: date example: '2019-01-01' description: Planned end date of the project. Must be on or after start_date when both are set. 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: Id of the project owner. project_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project type. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). 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-01' description: Date when the project starts. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. revenue_goal: type: object 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. required: - base_value - currency_id - value_foreign description: Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this project. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectSharingSalesUnitRelation, see: ''updateProjectSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectSharingClientRelation, see: ''updateProjectSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this project. Editable only when share_mode allows user sharing. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectContactRelation, see: ''updateProjectContactRelationInput'' object for properties.' description: Contacts linked to this project, including the primary-contact flag. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this project. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this project currently matches. ProjectKPI: 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client: type: string format: uri description: 'User who triggered the KPI event (project completion). 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.' owner: type: string format: uri description: 'Project owner at the time the KPI event occurred. 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: string format: uri description: 'Project this KPI event relates to. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' unit: type: string format: uri description: 'Sales unit the triggering user belonged to at the time of the event. 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.' application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: ProjectCompleted. Integer enum value: 1 - ProjectCompleted' example: 1 enum: - 1 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project owner at the time of the event. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - owner - project - kpi - owner_id - project_id ProjectDataExRelation: 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true data: type: string format: uri description: 'External data record (Data entity) holding the enrichment payload. Relation to Data. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Data'' object for properties.' project: type: string format: uri description: 'Project this enrichment record applies to. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the external data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the enrichment record originates from. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - data - project - data_id - data_set_id - project_id createProjectSharingClientRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - client_id - project_id createProjectInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the related account. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this project. description: type: string example: string description: Free-form description of the project. end_date: type: string format: date example: '2019-01-01' description: Planned end date of the project. Must be on or after start_date when both are set. 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: Id of the project owner. project_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project type. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). 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-01' description: Date when the project starts. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. revenue_goal: type: object 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. required: - base_value - currency_id - value_foreign description: Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''createCloudObjectRelationInput'' object for properties.' description: Documents linked to this project. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectSharingSalesUnitRelation, see: ''createProjectSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectSharingClientRelation, see: ''createProjectSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this project. Editable only when share_mode allows user sharing. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProjectContactRelation, see: ''createProjectContactRelationInput'' object for properties.' description: Contacts linked to this project, including the primary-contact flag. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''createTagRelationInput'' object for properties.' description: Tag labels applied to this project. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''createProfileRelationInput'' object for properties.' description: Saved view profiles this project currently matches. required: - end_date - name - owner_id - revenue_goal batchProjectKPIInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: ProjectCompleted. Integer enum value: 1 - ProjectCompleted' example: 1 enum: - 1 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project owner at the time of the event. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createProjectKPIInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: ProjectCompleted. Integer enum value: 1 - ProjectCompleted' example: 1 enum: - 1 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project owner at the time of the event. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - kpi - owner_id - project_id createProjectSharingSalesUnitRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - project_id - unit_id updateProjectContactRelationInput: properties: contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. Project: 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account this project is delivered for, or empty for internal projects without an external account. 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.' currency_exchange_rates_list: type: string format: uri description: 'Currency exchange rate list used to convert monetary fields linked to this project. Empty to inherit the team space default. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CurrencyExchangeRatesList'' object for properties.' owner: type: string format: uri description: 'Sales user who owns this project. 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: 'Project type that classifies this project. Project types are configurable per team space and drive which form, fields and objectives apply. 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: 'Sales unit this project is assigned to. Determines which team members can see the record under unit-based sharing. 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: Id of the related account. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this project. description: type: string example: string description: Free-form description of the project. end_date: type: string format: date example: '2019-01-01' description: Planned end date of the project. Must be on or after start_date when both are set. 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: Id of the project owner. project_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project type. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). 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-01' description: Date when the project starts. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. revenue_goal: type: object 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. required: - base_value - currency_id - value_foreign description: Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. documents: type: array 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.' description: Documents linked to this project. sharing_units: type: array 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.' description: Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing. sharing_clients: type: array 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.' description: Users that have been granted shared access to this project. Editable only when share_mode allows user sharing. primary_contact: type: string format: uri description: 'Primary contact of this project. Set automatically from the contact relation marked as primary. 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 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.' description: Contacts linked to this project, including the primary-contact flag. tags: type: array 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.' description: Tag labels applied to this project. static_profiles: type: array items: type: string format: uri description: 'Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ProfileRelation'' object for properties.' description: Saved view profiles this project currently matches. objectives: type: array 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.' description: Objectives defined for this project, sorted by display order. is_favorite: type: boolean example: false description: True when the current authenticated user has marked this project as favorite. Per-user. status: type: integer description: 'Current status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress. 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: Percentage of activities (tasks and appointments) on this project that are completed. Read-only; computed by Coevera. activities_total: type: number format: double example: '4.32' description: Total number of activities (tasks and appointments) linked to this project. Read-only; computed by Coevera. activities_completed: type: number format: double example: '4.32' description: Number of completed activities on this project. Read-only; computed by Coevera. formatted_name: type: string example: string description: Display version of the project name, used in lists and references. modified_by_user: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. required: - is_delete_protected - id - owner - project_type - unit - end_date - name - owner_id - revenue_goal - is_favorite - status - formatted_name updateProjectKPIInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: ProjectCompleted. Integer enum value: 1 - ProjectCompleted' example: 1 enum: - 1 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project owner at the time of the event. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createProjectTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing projects of this type. icon: type: integer description: 'Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). Integer enum value: 0 - GeneralIcon, 1 - Account' example: 0 enum: - 0 - 1 is_readonly: type: boolean example: false description: True when the project type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_readonly - name - settings batchProjectTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing projects of this type. icon: type: integer description: 'Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). Integer enum value: 0 - GeneralIcon, 1 - Account' example: 0 enum: - 0 - 1 is_readonly: type: boolean example: false description: True when the project type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid ProjectSharingClientRelation: 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' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client: type: string format: uri description: 'User the project is shared with. 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: string format: uri description: 'Project being shared. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - client - project - client_id - project_id batchProjectContactRelationInput: properties: contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the project. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchProjectSharingSalesUnitRelationInput: properties: project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared project. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid