src/swagger.components.schemas.jsonmodified{
"schemas": {
"PaginationEnvelope": {
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"type": "object"
}
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"lastFetchedIndexId": {
"type": "integer",
"format": "int64"
}
},
"required": ["records", "recordCount", "lastFetchedIndexId"]
},
"Data": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"validMethods": {
"type": "array",
"items": {
"type": "string"
}
},
"required": {
"type": "boolean"
},
"order": {
"type": "number"
}
}
},
"ParameterDTO": {
"type": "object",
"properties": {
"mainType": {
"type": "string",
"enum": [
"ISSUE_DEFAULT",
"ISSUE_CUSTOM",
"PROJECT_DEFAULT"
]
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"dataType": {
"type": "string",
"enum": [
"TEXT",
"NUMBER",
"SINGLE_SELECT_LIST",
"CUSTOM_CHOICE",
"DATE"
]
},
"visualType": {
"type": "string",
"enum": [
"TEXT_BOX",
"TEXT_AREA",
"COMBO",
"DATE"
]
},
"required": {
"type": "boolean"
},
"cdeId": {
"type": "string"
},
"cdeType": {
"type": "string",
"enum": [
"ACC",
"PROCORE"
]
},
"issueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Data"
}
},
"issueSubtypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Data"
}
},
"data": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Data"
}
},
"order": {
"type": "number"
}
}
},
"UserProjectReportDTO": {
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"tenantName": {
"type": "string"
},
"projectId": {
"type": "string"
},
"projectName": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"showProgressCompletion": {
"type": "boolean"
},
"progressProject": {
"type": "boolean"
},
"progressDataCapture": {
"type": "string",
"enum": [
"GOOD",
"IN_PROGRESS",
"HIDDEN"
]
},
"contractor": {
"type": "string"
},
"contractorId": {
"type": "string",
"nullable": true
},
"buildType": {
"type": "string",
"enum": [
"SELF_BUILD",
"LEASE"
]
},
"projectProgress": {
"$ref": "#/components/schemas/ProjectProgressDTO"
},
"favorite": {
"type": "boolean"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastViewedAt": {
"type": "string",
"format": "date-time"
}
}
},
"ProjectProgressDTO": {
"type": "object",
"properties": {
"plannedEndDate": {
"type": "string",
"format": "date",
"nullable": true
},
"plannedStartDate": {
"type": "string",
"format": "date",
"nullable": true
}
}
},
"ProjectWithProgress": {
"allOf": [
{ "$ref": "#/components/schemas/Project" },
{
"type": "object",
"properties": {
"issueCount": { "type": "number" },
"progressDataCapture": { "type": "string" },
"region": { "type": "string" },
"projectProgress": { "$ref": "#/components/schemas/ProjectProgressDTO" }
},
"required": ["issueCount", "progressDataCapture", "region", "projectProgress"]
}
]
},
"PeopleDTO": {
"type": "object",
"properties": {
"contactId": {
"type": "string"
},
"firstName": {
"type": "string",
"maxLength": 50
},
"lastName": {
"type": "string",
"maxLength": 50
},
"fullName": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"minLength": 5,
"maxLength": 254
},
"companyName": {
"type": "string"
},
"userStatus": {
"type": "string"
},
"companyType": {
"type": "string",
"enum": [
"OWNER",
"MAIN_CONTRACTOR",
"SUBCONTRACTOR"
]
},
"userRoleCode": {
"type": "string"
},
"userRoleName": {
"type": "string"
},
"langKey": {
"type": "string",
"minLength": 2,
"maxLength": 10
},
"createdBy": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastModifiedBy": {
"type": "string"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
}
}
},
"UserProjectDTO": {
"type": "object",
"properties": {
"projectId": {
"type": "string"
}
}
},
"ProjectBasePoint": {
"type": "object",
"properties": {
"northing": {
"type": "number"
},
"easting": {
"type": "number"
},
"elevation": {
"type": "number"
},
"trueNorthAngle": {
"type": "number"
}
}
},
"Project": {
"type": "object",
"properties": {
"projectId": {
"type": "string"
},
"mongoProjectId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"timezone": {
"type": "string"
},
"tenantName": {
"type": "string"
},
"contractor": {
"type": "string"
},
"contractorId": {
"type": "string",
"nullable": true
},
"measurementType": {
"type": "string"
},
"autodeskCloudHubId": {
"type": "string"
},
"mongoTenantId": {
"type": "string"
},
"accProjectId": {
"type": "string"
},
"targetAccFolderUrn": {
"type": "string"
},
"favourite": {
"type": "string"
},
"country": {
"type": "string"
},
"city": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"postcode": {
"type": "string"
},
"currencyName": {
"type": "string"
},
"isPortfolioEnabled": {
"type": "boolean"
},
"currencyCode": {
"type": "string"
},
"progressWeightingMethod": {
"type": "string",
"enum": [
"PLANNED_LABOUR_HOURS",
"LINKED_ELEMENT_COUNT"
]
},
"basePoint": {
"$ref": "#/components/schemas/ProjectBasePoint"
},
"latitude": {
"type": "number",
"nullable": true
},
"longitude": {
"type": "number",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"progressProject": {
"type": "boolean",
"nullable": true,
"description": "Whether progress tracking is enabled for the project."
},
"disciplines": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
"ProjectUserDTO": {
"type": "object",
"properties": {
"projectId": {
"type": "string"
},
"users": {
"$ref": "#/components/schemas/UserDTO"
}
}
},
"UserDTO": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contactId": {
"type": "string"
},
"firstName": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"lastName": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"email": {
"type": "string"
},
"pin": {
"type": "string"
},
"authorities": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"calibration": {
"type": "string"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRoleDTO"
}
}
}
},
"UserRoleDTO": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"projectName": {
"type": "string"
},
"projectId": {
"type": "string"
}
}
},
"MarkerCornerDTO": {
"type": "object",
"properties": {
"topLeft": {
"$ref": "#/components/schemas/VectorDTO"
},
"topRight": {
"$ref": "#/components/schemas/VectorDTO"
},
"bottomLeft": {
"$ref": "#/components/schemas/VectorDTO"
},
"bottomRight": {
"$ref": "#/components/schemas/VectorDTO"
},
"createdBy": {
"type": "string",
"minLength": 1
},
"createdDate": {
"type": "string",
"format": "date-time"
}
},
"required": [
"bottomLeft",
"bottomRight",
"createdDate",
"topLeft",
"topRight"
]
},
"VectorDTO": {
"type": "object",
"properties": {
"xCoordinate": {
"type": "string",
"minLength": 1
},
"yCoordinate": {
"type": "string",
"minLength": 1
},
"zCoordinate": {
"type": "string",
"minLength": 1
}
}
},
"DeviceProjectInfo": {
"type": "object",
"properties": {
"projectId": {
"type": "string"
},
"projectName": {
"type": "string"
}
}
},
"Device": {
"type": "object",
"properties": {
"deviceId": {
"type": "string",
"format": "uuid"
},
"projectId": {
"type": "string"
},
"projectName": {
"type": "string"
},
"deviceName": {
"type": "string"
},
"deviceCode": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tenantName": {
"type": "string"
},
"isActivated": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"AVAILABLE",
"ASSIGNEDTOTENANT",
"ASSIGNEDTOPROJECT"
]
},
"deviceUdi": {
"type": "string",
"format": "uuid"
},
"legacyDeviceId": {
"type": "string"
}
}
},
"ProjectProgressWeightingDTO": {
"type": "object",
"properties": {
"ProjectId": {
"type": "string"
},
"ProgressWeightingId": {
"type": "string"
},
"Method": {
"type": "string"
},
"PlannedProgressColumnName": {
"type": "string"
},
"ActualProgressColumnName": {
"type": "string"
}
},
"required": [
"ProjectId",
"ProgressWeightingId",
"Method",
"PlannedProgressColumnName",
"ActualProgressColumnName"
]
},
"ActivityCategoryType": {
"type": "object",
"properties": {
"categoryTypeId": { "type": "string" },
"typeName": { "type": "string" },
"typeDescription": { "type": "string" },
"hierarchyLevel": { "type": "string" },
"actvCodeTypeScope": { "type": "string" },
"importedFromSchedule": { "type": "boolean" },
"createdBy": { "type": "string" },
"updatedBy": { "type": "string" },
"updatedOn": { "type": "string", "format": "date-time" },
"enabled": { "type": "boolean" }
}
},
"PortfolioReportResponse": {
"type": "object",
"properties": {
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PortfolioProjectReport"
}
}
}
},
"PortfolioProjectReport": {
"type": "object",
"properties": {
"projectId": { "type": "string" },
"mongoProjectId": { "type": "string" },
"projectName": { "type": "string" },
"iconUrl": { "type": "string" },
"description": { "type": "string" },
"tenantId": { "type": "string" },
"city": { "type": "string" },
"postcode": { "type": "string" },
"addressLine1": { "type": "string" },
"addressLine2": { "type": "string" },
"currencyId": { "type": "string" },
"plannedStartDate": { "type": "string" },
"plannedEndDate": { "type": "string" },
"progressWeighting": { "type": "string" },
"plannedProgress": { "type": "number" },
"actualProgress": { "type": "number" },
"totalPlannedHours": { "type": "number" },
"plannedLaborUnits": { "type": "number" },
"contractorId": { "type": "string" },
"region": { "type": "string", "nullable": true },
"status": {
"type": "string",
"enum": ["CRITICAL", "ON TRACK"]
},
"locationCoordinates": {
"type": "object",
"properties": {
"lat": { "type": "number" },
"long": { "type": "number" }
}
},
"intervalProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"year": { "type": "number" },
"avgSpi": { "type": "number" },
"interval": { "type": "number" },
"intervalType": {
"type": "string",
"enum": ["WEEK", "MONTH", "QUARTER"]
}
}
}
},
"quality": {
"type": "object",
"properties": {
"issuesResolved": { "type": "number" },
"issuesRaised": { "type": "number" },
"costMitigated": { "type": "number" },
"costIdentified": { "type": "number" },
"avgResolutionTime": { "type": "number" },
"intervalData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": { "type": "string" },
"issuesRaised": { "type": "number" },
"issuesResolved": { "type": "number" }
}
}
}
}
}
}
},
"PerformanceRating": {
"type": "object",
"properties": {
"projectId": { "type": "string", "format": "uuid" },
"mongoCompanyId": { "type": "string" },
"snapshotDate": { "type": "string", "format": "date" },
"paceScore": { "type": "number" },
"consistencyScore": { "type": "number" },
"projectRating": { "type": "number" },
"weeklyRatingPctChange": { "type": "number", "nullable": true }
}
},
"PerformanceRatingsResponse": {
"type": "object",
"properties": {
"ratings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PerformanceRating"
}
}
}
},
"PortfolioMilestone": {
"type": "object",
"properties": {
"milestoneId": { "type": "string" },
"name": { "type": "string" },
"projectId": { "type": "string", "format": "uuid" },
"plannedDate": { "type": "string", "format": "date", "nullable": true },
"forecastDate": { "type": "string", "format": "date", "nullable": true },
"actualDate": { "type": "string", "format": "date", "nullable": true },
"status": { "type": "string", "enum": ["COMPLETE", "ON_TRACK", "AT_RISK", "LATE"], "nullable": true },
"slippageDays": { "type": "integer", "nullable": true }
}
},
"PortfolioMilestonesResponse": {
"type": "object",
"properties": {
"portfolioId": { "type": "string", "format": "uuid" },
"milestones": {
"type": "array",
"items": { "$ref": "#/components/schemas/PortfolioMilestone" }
}
}
},
"HistoryFieldValue": {
"type": "object",
"description": "One side of a scalar field change in the issue history feed.",
"required": ["value"],
"properties": {
"value": {
"type": "string",
"nullable": true,
"description": "The resolved display scalar: a status/severity name, title, cost, date, email address, etc."
},
"displayName": {
"type": "string",
"nullable": true,
"description": "Resolved human name when `value` is a user/email identifier; omitted for non-user fields."
}
}
},
"ActivityCategoryItem": {
"type": "object",
"description": "One entry in an activityCategories mapping change.",
"required": ["id", "name", "typeId", "typeName"],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the activity category."
},
"name": {
"type": "string",
"nullable": true,
"description": "Display name of the activity category."
},
"typeId": {
"type": "string",
"nullable": true,
"description": "Identifier of the activity category type."
},
"typeName": {
"type": "string",
"nullable": true,
"description": "Display name of the activity category type."
}
}
},
"CommissioningWorkflow": {
"type": "object",
"description": "A workflow representing the full life-cycle commissioning process for on-site assets.",
"required": ["commissioningWorkflowId", "name", "createdBy", "insertedOn"],
"properties": {
"commissioningWorkflowId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the commissioning workflow."
},
"name": {
"type": "string",
"description": "Name of the commissioning workflow."
},
"createdBy": {
"type": "string",
"description": "Username of the user who created the workflow."
},
"insertedOn": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp when the workflow was created."
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "UTC timestamp of the last modification."
},
"lastModifiedBy": {
"type": "string",
"nullable": true,
"description": "Username of the user who last modified the workflow."
}
}
},
"Asset": {
"type": "object",
"description": "A project-scoped asset classified by an asset type.",
"required": ["assetId", "name", "assetTypeId", "createdBy", "insertedOn"],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the asset."
},
"name": {
"type": "string",
"description": "Name of the asset."
},
"assetTypeId": {
"type": "string",
"format": "uuid",
"description": "ID of the asset type associated with this asset."
},
"systemId": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "Scalar ID of the system type the asset's asset type is mapped to, derived from the AssetType to SystemType mapping. Null when no mapping exists."
},
"createdBy": {
"type": "string",
"description": "Username of the user who created the asset."
},
"insertedOn": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp when the asset was created."
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "UTC timestamp of the last modification."
},
"lastModifiedBy": {
"type": "string",
"nullable": true,
"description": "Username of the user who last modified the asset."
}
}
},
"AssetType": {
"type": "object",
"description": "A project-scoped asset type used to classify assets.",
"required": ["assetTypeId", "name", "commissioningWorkflowId", "createdBy", "insertedOn"],
"properties": {
"assetTypeId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the asset type."
},
"name": {
"type": "string",
"description": "Name of the asset type."
},
"commissioningWorkflowId": {
"type": "string",
"format": "uuid",
"description": "ID of the commissioning workflow associated with this asset type."
},
"description": {
"type": "string",
"nullable": true,
"description": "Optional description of the asset type."
},
"createdBy": {
"type": "string",
"description": "Username of the user who created the asset type."
},
"insertedOn": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp when the asset type was created."
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "UTC timestamp of the last modification."
},
"lastModifiedBy": {
"type": "string",
"nullable": true,
"description": "Username of the user who last modified the asset type."
}
}
},
"AssetTypeSystemTypeMapping": {
"type": "object",
"description": "A project-scoped mapping linking an asset type to a system type.",
"required": ["mappingId", "assetTypeId", "systemTypeId", "createdBy", "insertedOn"],
"properties": {
"mappingId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the mapping."
},
"assetTypeId": {
"type": "string",
"format": "uuid",
"description": "ID of the mapped asset type."
},
"systemTypeId": {
"type": "string",
"format": "uuid",
"description": "ID of the mapped system type."
},
"createdBy": {
"type": "string",
"description": "Username of the user who created the mapping."
},
"insertedOn": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp when the mapping was created."
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "UTC timestamp of the last modification."
},
"lastModifiedBy": {
"type": "string",
"nullable": true,
"description": "Username of the user who last modified the mapping."
}
}
},
"System": {
"type": "object",
"description": "A project-scoped system (commissioning system) classified by a system type.",
"required": ["systemId", "name", "systemTypeId", "createdBy", "insertedOn"],
"properties": {
"systemId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the system."
},
"name": {
"type": "string",
"description": "Name of the system."
},
"systemTypeId": {
"type": "string",
"format": "uuid",
"description": "ID of the system type associated with this system."
},
"createdBy": {
"type": "string",
"description": "Username of the user who created the system."
},
"insertedOn": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp when the system was created."
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "UTC timestamp of the last modification."
},
"lastModifiedBy": {
"type": "string",
"nullable": true,
"description": "Username of the user who last modified the system."
}
}
},
"SystemType": {
"type": "object",
"description": "A system type grouping connected assets and mapping them to a commissioning workflow.",
"required": ["systemTypeId", "name", "commissioningWorkflowId", "createdBy", "insertedOn"],
"properties": {
"systemTypeId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the system type."
},
"name": {
"type": "string",
"description": "Name of the system type."
},
"commissioningWorkflowId": {
"type": "string",
"format": "uuid",
"description": "ID of the commissioning workflow associated with this system type."
},
"createdBy": {
"type": "string",
"description": "Username of the user who created the system type."
},
"insertedOn": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp when the system type was created."
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "UTC timestamp of the last modification."
},
"lastModifiedBy": {
"type": "string",
"nullable": true,
"description": "Username of the user who last modified the system type."
}
}
}
}
}