diff --git a/docs/swagger.yaml b/docs/swagger.yaml index b653e9d8..6ca77135 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -804,6 +804,726 @@ paths: description: Internal Server Error schema: $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/workstreams': + parameters: + - $ref: '#/parameters/projectIdParam' + get: + tags: + - workstream + operationId: findWorkStreams + security: + - Bearer: [] + description: >- + Retrieve all project workstreams. + responses: + '200': + description: A list of project work streams + schema: + type: array + items: + $ref: '#/definitions/WorkStream' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + post: + tags: + - workstream + operationId: addWorkStream + security: + - Bearer: [] + description: >- + Create a work stream. + parameters: + - in: body + name: body + required: true + schema: + type: object + allOf: + - $ref: '#/definitions/WorkStreamRequest' + responses: + '200': + description: Returns the newly created project work stream + schema: + $ref: '#/definitions/WorkStream' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/workstreams/{workStreamId}': + parameters: + - $ref: '#/parameters/projectIdParam' + - $ref: '#/parameters/workStreamIdParam' + get: + tags: + - workstream + description: >- + Retrieve work stream by id. + security: + - Bearer: [] + responses: + '200': + description: a project work stream + schema: + $ref: '#/definitions/WorkStream' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/workStreamIdParam' + operationId: getWorkStream + patch: + tags: + - workstream + operationId: updateWorkStream + security: + - Bearer: [] + description: >- + Update a project work stream. + responses: + '200': + description: Successfully updated project work stream. + schema: + $ref: '#/definitions/WorkStream' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - name: body + in: body + required: true + schema: + $ref: '#/definitions/WorkStreamRequest' + delete: + tags: + - workstream + description: >- + Remove an existing project work stream. + security: + - Bearer: [] + responses: + '204': + description: Project work stream successfully removed + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/workstreams/{workStreamId}/works': + parameters: + - $ref: '#/parameters/projectIdParam' + - $ref: '#/parameters/workStreamIdParam' + get: + tags: + - work + operationId: findWorks + security: + - Bearer: [] + description: >- + Retrieve all works for given project and workstream. + parameters: + - name: fields + required: false + type: string + in: query + description: | + Comma separated list of project phase fields to return. + - name: sort + required: false + description: > + sort project phases by startDate, endDate, status, order. Default is + startDate asc + in: query + type: string + responses: + '200': + description: A list of project works + schema: + type: array + items: + $ref: '#/definitions/ProjectPhase' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project or workstream is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + post: + tags: + - work + operationId: addWork + security: + - Bearer: [] + description: >- + Create a work + parameters: + - in: body + name: body + required: true + schema: + type: object + allOf: + - $ref: '#/definitions/ProjectPhaseRequest' + responses: + '200': + description: Returns the newly created project work + schema: + $ref: '#/definitions/ProjectPhase' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project or workstream is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/workstreams/{workStreamId}/works/{phaseId}': + parameters: + - $ref: '#/parameters/projectIdParam' + - $ref: '#/parameters/phaseIdParam' + - $ref: '#/parameters/workStreamIdParam' + get: + tags: + - work + description: >- + Retrieve work by id. + security: + - Bearer: [] + responses: + '200': + description: a project work + schema: + $ref: '#/definitions/ProjectPhase' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/phaseIdParam' + operationId: getWork + patch: + tags: + - work + operationId: updateWork + security: + - Bearer: [] + description: >- + Update work for given project and workstream. + responses: + '200': + description: Successfully updated project work. + schema: + $ref: '#/definitions/ProjectPhase' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/phaseIdParam' + - name: body + in: body + required: true + schema: + $ref: '#/definitions/ProjectPhaseRequest' + delete: + tags: + - work + description: >- + Remove an existing work by id for given project and workstream. + security: + - Bearer: [] + parameters: + - $ref: '#/parameters/phaseIdParam' + responses: + '204': + description: Work successfully removed + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project or workstream is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/workstreams/{workStreamId}/works/{phaseId}/workitems': + parameters: + - $ref: '#/parameters/projectIdParam' + - $ref: '#/parameters/phaseIdParam' + - $ref: '#/parameters/workStreamIdParam' + get: + tags: + - work item + operationId: findWorkItems + security: + - Bearer: [] + description: >- + Retrieve all work items for given project, workstream and phase. + responses: + '200': + description: A list of work items + schema: + type: array + items: + $ref: '#/definitions/PhaseProduct' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project, workstream or phase is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + post: + tags: + - work item + operationId: addWorkItem + security: + - Bearer: [] + description: Create a work item for given project, workstream and phase. + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/PhaseProductRequest' + responses: + '200': + description: Returns the newly created work item + schema: + $ref: '#/definitions/PhaseProduct' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project, workstream or phase is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/workstreams/{workStreamId}/works/{phaseId}/workitems/{productId}': + parameters: + - $ref: '#/parameters/projectIdParam' + - $ref: '#/parameters/phaseIdParam' + - $ref: '#/parameters/workStreamIdParam' + - $ref: '#/parameters/productIdParam' + get: + tags: + - work item + description: >- + Retrieve work item by id for given project, workstream and phase. + security: + - Bearer: [] + responses: + '200': + description: a work item + schema: + $ref: '#/definitions/PhaseProduct' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/phaseIdParam' + operationId: getWorkItem + patch: + tags: + - work item + operationId: updateWorkItem + security: + - Bearer: [] + description: >- + Update a work item for given project, workstream and phase. + responses: + '200': + description: Successfully updated work item. + schema: + $ref: '#/definitions/PhaseProduct' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/phaseIdParam' + - name: body + in: body + required: true + schema: + $ref: '#/definitions/PhaseProductRequest' + delete: + tags: + - work item + description: >- + Remove an existing work item by id for given project, workstream and phase. + security: + - Bearer: [] + parameters: + - $ref: '#/parameters/phaseIdParam' + responses: + '204': + description: Work item successfully removed + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project, workstream or phase is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/settings': + parameters: + - $ref: '#/parameters/projectIdParam' + get: + tags: + - project settings + operationId: findProjectSettings + security: + - Bearer: [] + description: >- + Retrieve all project settings. Only users with readPermission can get the setting + responses: + '200': + description: A list of project phases + schema: + type: array + items: + $ref: '#/definitions/ProjectSetting' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + post: + tags: + - project settings + operationId: addProjectSetting + security: + - Bearer: [] + description: >- + Create a project setting and create project estimation items based on estimation type. + parameters: + - in: body + name: body + required: true + schema: + type: object + allOf: + - $ref: '#/definitions/ProjectSettingRequest' + responses: + '200': + description: Returns the newly created project phase + schema: + $ref: '#/definitions/ProjectPhase' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/settings/{settingId}': + parameters: + - $ref: '#/parameters/projectIdParam' + - $ref: '#/parameters/settingIdParam' + patch: + tags: + - project settings + operationId: updateProjectSetting + security: + - Bearer: [] + description: >- + Update a project setting. All user with write permission can edit the setting. + responses: + '200': + description: Successfully updated project setting. + schema: + $ref: '#/definitions/ProjectSetting' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - name: body + in: body + required: true + schema: + $ref: '#/definitions/ProjectSettingRequest' + delete: + tags: + - project settings + description: >- + Remove an existing project setting. All users who are connect managers and admins + access this endpoint. + security: + - Bearer: [] + parameters: + - $ref: '#/parameters/settingIdParam' + responses: + '204': + description: Project setting successfully removed + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If project is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/{projectId}/estimations/{estimationId}/items': + get: + tags: + - Project Estimation Items + security: + - Bearer: [] + description: get project estimation items + parameters: + - $ref: '#/parameters/projectIdParam' + - $ref: '#/parameters/projectEstimationIdParam' + responses: + '200': + description: List of project estimation items + schema: + type: array + items: + $ref: '#/definitions/ProjectEstimationItem' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Model not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Invalid server state or unknown error + schema: + $ref: '#/definitions/ErrorModel' '/projects/{projectId}/phases/{phaseId}/products': parameters: - $ref: '#/parameters/projectIdParam' @@ -1960,7 +2680,233 @@ paths: '400': description: Bad request schema: - $ref: '#/definitions/ErrorModel' + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If organization config is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + /projects/metadata/workManagementPermission: + get: + tags: + - workManagementPermission + operationId: findWorkManagementPermissions + security: + - Bearer: [] + description: >- + Retrieve all work management permissions. Only admin or connect admin can access + this endpoint. + parameters: + - name: filter + required: true + type: string + in: query + description: | + Url encoded list of Supported filters + - projectTemplateId (required) + responses: + '200': + description: A list of work management permissions + schema: + type: array + items: + $ref: '#/definitions/WorkManagementPermission' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + post: + tags: + - workManagementPermission + operationId: addWorkManagementPermission + security: + - Bearer: [] + description: >- + Create a work management permission. Only admin or connect admin can access + this endpoint. + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/WorkManagementPermissionCreateRequest' + responses: + '200': + description: Returns the newly created work management permission + schema: + $ref: '#/definitions/WorkManagementPermission' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + '/projects/metadata/workManagementPermission/{id}': + get: + tags: + - workManagementPermission + description: Retrieve work management permission by id. Only admin or connect admin can access + this endpoint. + security: + - Bearer: [] + responses: + '200': + description: a project type + schema: + $ref: '#/definitions/WorkManagementPermission' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/permissionIdParam' + operationId: getWorkManagementPermission + patch: + tags: + - workManagementPermission + operationId: updateWorkManagementPermission + security: + - Bearer: [] + description: >- + Update a work management permission. Only admin or connect admin can access + this endpoint. + responses: + '200': + description: Successfully updated work management permission. + schema: + $ref: '#/definitions/WorkManagementPermission' + '400': + description: Bad request + schema: + $ref: '#/definitions/ErrorModel' + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: Not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/permissionIdParam' + - name: body + in: body + required: true + schema: + $ref: '#/definitions/WorkManagementPermissionCreateRequest' + delete: + tags: + - workManagementPermission + description: >- + Remove an existing work management permission. Only admin or connect admin can + access this endpoint. + security: + - Bearer: [] + parameters: + - $ref: '#/parameters/permissionIdParam' + responses: + '204': + description: Work management permission successfully removed + '401': + description: Unauthorized + schema: + $ref: '#/definitions/ErrorModel' + '403': + description: Forbidden + schema: + $ref: '#/definitions/ErrorModel' + '404': + description: If work management permission is not found + schema: + $ref: '#/definitions/ErrorModel' + '500': + description: Internal Server Error + schema: + $ref: '#/definitions/ErrorModel' + + '/projects/{projectId}/permissions': + get: + tags: + - permissions + description: Retrieve permissions. + security: + - Bearer: [] + responses: + '200': + description: permissions + schema: + title: Single work management permission response object + type: object + properties: + id: + type: string + description: unique id identifying the request + version: + type: string + result: + type: object + properties: + success: + type: boolean + status: + type: integer + format: int32 + description: http status code + metadata: + $ref: '#/definitions/ResponseMetadata' + content: + type: object + example: + 'work.create': true '401': description: Unauthorized schema: @@ -1970,13 +2916,16 @@ paths: schema: $ref: '#/definitions/ErrorModel' '404': - description: If organization config is not found + description: Not found schema: $ref: '#/definitions/ErrorModel' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorModel' + parameters: + - $ref: '#/parameters/projectIdParam' + operationId: getPermissions /timelines: get: tags: @@ -3660,6 +4609,22 @@ parameters: type: integer format: int64 minimum: 1 + workStreamIdParam: + name: workStreamId + in: path + description: work stream identifier + required: true + type: integer + format: int64 + minimum: 1 + settingIdParam: + name: settingId + in: path + description: project setting identifier + required: true + type: integer + format: int64 + minimum: 1 productIdParam: name: productId in: path @@ -3721,6 +4686,13 @@ parameters: required: true type: integer format: int64 + permissionIdParam: + name: id + in: path + description: work management permission id + required: true + type: integer + format: int64 pageParam: name: page in: query @@ -3824,6 +4796,13 @@ parameters: description: manager filter required: false type: string + projectEstimationIdParam: + name: estimationId + in: path + description: project estimation identifier + required: true + type: integer + format: int64 definitions: ResponseMetadata: title: Metadata object for a response @@ -3902,7 +4881,7 @@ definitions: - buildingBlockKey properties: conditions: - type: string + type: string price: type: number format: float @@ -3915,7 +4894,7 @@ definitions: metadata: type: object buildingBlockKey: - type: string + type: string type: type: string description: project type @@ -4476,6 +5455,12 @@ definitions: name: type: string description: the project phase name + description: + type: string + description: the project phase short description + requirements: + type: string + description: the project phase requirements status: type: string description: the project phase status @@ -4954,12 +5939,16 @@ definitions: blockedText: type: string description: the milestone blocked text + statusComment: + type: string + description: the milestone status history comment Milestone: title: Milestone object allOf: - type: object required: - id + - statusHistory - createdAt - createdBy - updatedAt @@ -4969,6 +5958,8 @@ definitions: type: number format: int64 description: the id + statusHistory: + $ref: '#/definitions/StatusHistory' createdAt: type: string description: Datetime (GMT) when object was created @@ -5117,6 +6108,10 @@ definitions: type: array items: $ref: '#/definitions/ProductCategory' + buildingBlocks: + type: array + items: + $ref: '#/definitions/BuildingBlock' ProjectMemberInvite: type: object properties: @@ -5352,3 +6347,320 @@ definitions: config: description: config json type: object + ProjectSetting: + title: Project setting object + allOf: + - type: object + required: + - id + - createdAt + - createdBy + - updatedAt + - updatedBy + properties: + id: + type: number + format: int64 + description: the id + createdAt: + type: string + description: Datetime (GMT) when object was created + readOnly: true + createdBy: + type: integer + format: int64 + description: READ-ONLY. User who created this object + readOnly: true + updatedAt: + type: string + description: READ-ONLY. Datetime (GMT) when object was updated + readOnly: true + updatedBy: + type: integer + format: int64 + description: READ-ONLY. User that last updated this object + readOnly: true + - $ref: '#/definitions/ProjectSettingRequest' + ProjectSettingRequest: + title: Project setting request object + type: object + required: + - key + - value + - valueType + - readPermission + - writePermission + - metadata + properties: + key: + type: string + description: the project setting key + value: + type: string + description: the project setting value + valueType: + type: string + description: the project setting value type + readPermission: + type: object + description: the project setting read Permission + writePermission: + type: object + description: the project setting write Permission + metadata: + type: object + description: the project setting metadata + WorkStream: + title: Work stream object + allOf: + - type: object + required: + - id + - createdAt + - createdBy + - updatedAt + - updatedBy + properties: + id: + type: number + format: int64 + description: the id + projectId: + type: number + format: int64 + description: the project id + createdAt: + type: string + description: Datetime (GMT) when object was created + readOnly: true + createdBy: + type: integer + format: int64 + description: READ-ONLY. User who created this object + readOnly: true + updatedAt: + type: string + description: READ-ONLY. Datetime (GMT) when object was updated + readOnly: true + updatedBy: + type: integer + format: int64 + description: READ-ONLY. User that last updated this object + readOnly: true + - $ref: '#/definitions/WorkStreamRequest' + WorkStreamRequest: + title: Work stream request object + type: object + required: + - name + - status + - type + properties: + name: + type: string + description: the work stream name + status: + type: string + description: the work stream status + type: + type: string + description: the type + WorkManagementPermissionCreateRequest: + title: Work Management Permission request object + type: object + required: + - policy + - permission + - projectTemplateId + properties: + policy: + type: string + description: the policy + permission: + type: object + description: the permission + projectTemplateId: + type: number + format: int64 + description: the template id + WorkManagementPermission: + title: Work Management Permission object + allOf: + - type: object + required: + - id + - policy + - permission + - projectTemplateId + - createdAt + - createdBy + - updatedAt + - updatedBy + properties: + id: + type: number + format: int64 + description: the id + policy: + type: string + description: the policy + permission: + type: object + description: the permission + projectTemplateId: + type: number + format: int64 + description: the template id + createdAt: + type: string + description: Datetime (GMT) when object was created + readOnly: true + createdBy: + type: integer + format: int64 + description: READ-ONLY. User who created this object + readOnly: true + updatedAt: + type: string + description: READ-ONLY. Datetime (GMT) when object was updated + readOnly: true + updatedBy: + type: integer + format: int64 + description: READ-ONLY. User that last updated this object + readOnly: true + - $ref: '#/definitions/WorkManagementPermissionCreateRequest' + StatusHistory: + title: Status history object + type: object + required: + - id + - status + - reference + - referenceId + - comment + properties: + id: + type: string + description: the id + status: + type: string + description: the status + reference: + type: string + description: the referenced model + referenceId: + type: string + description: the referenced id + comment: + type: string + description: the comment + createdAt: + type: string + description: Datetime (GMT) when object was created + readOnly: true + createdBy: + type: integer + format: int64 + description: READ-ONLY. User who created this object + readOnly: true + updatedAt: + type: string + description: READ-ONLY. Datetime (GMT) when object was updated + readOnly: true + updatedBy: + type: integer + format: int64 + description: READ-ONLY. User that last updated this object + readOnly: true + BuildingBlock: + title: BuildingBlock object + type: object + required: + - id + - key + - config + properties: + id: + type: integer + format: int64 + description: the id + key: + type: string + description: building block key. Unique field. + config: + type: object + description: building block config + createdAt: + type: string + description: Datetime (GMT) when object was created + readOnly: true + createdBy: + type: integer + format: int64 + description: READ-ONLY. User who created this object + readOnly: true + updatedAt: + type: string + description: READ-ONLY. Datetime (GMT) when object was updated + readOnly: true + updatedBy: + type: integer + format: int64 + description: READ-ONLY. User that last updated this object + readOnly: true + ProjectEstimationItem: + title: ProjectEstimationItem object + type: object + required: + - id + - projectEstimationId + - price + - type + - markupUsedReference + - markupUsedReferenceId + - metadata + properties: + id: + type: integer + format: int64 + description: the id + projectEstimationId: + type: integer + format: int64 + description: the ProjectEstimation id + price: + type: number + format: float + description: the price of this estimation item + type: + type: string + description: the type of this estimation + markupUsedReference: + type: string + description: the reference type of this estimation. Can be "buildingBlock" for example + markupUsedReferenceId: + type: integer + format: int64 + description: the reference object id + metadata: + type: object + description: the metadata of this item + createdAt: + type: string + description: Datetime (GMT) when object was created + readOnly: true + createdBy: + type: integer + format: int64 + description: READ-ONLY. User who created this object + readOnly: true + updatedAt: + type: string + description: READ-ONLY. Datetime (GMT) when object was updated + readOnly: true + updatedBy: + type: integer + format: int64 + description: READ-ONLY. User that last updated this object + readOnly: true \ No newline at end of file