Download OpenAPI specification:Download
Welcome to the reference for the SmartPM REST API!
info The SmartPM REST API provides access to data for schedules that have been analyzed in SmartPM. If there is a particular dataset that you need access to that is missing from the API please contact us at support@smartpm.com.
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogId | integer <int64> |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| companyLogo | string |
object (WBSTreeLevel) |
{- "importLogId": 0,
- "paperSize": "Letter_Portrait",
- "companyLogo": "string",
- "wbsTreeLevel": {
- "to": 0,
- "from": 0
}
}0| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogId | integer <int64> |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| companyLogo | string |
object (WBSTreeLevel) |
{- "importLogId": 0,
- "paperSize": "Letter_Portrait",
- "companyLogo": "string",
- "wbsTreeLevel": {
- "to": 0,
- "from": 0
}
}0| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogId | integer <int64> |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| companyLogo | string |
| activityTypeCodes | Array of integers <int64> |
| activityCodeLabel | string Enum: "Value" "Description" |
{- "importLogId": 0,
- "paperSize": "Letter_Portrait",
- "companyLogo": "string",
- "activityTypeCodes": [
- 0
], - "activityCodeLabel": "Value"
}0| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogId | integer <int64> |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| companyLogo | string |
| activityTypeCodes | Array of integers <int64> |
| activityCodeLabel | string Enum: "Value" "Description" |
{- "importLogId": 0,
- "paperSize": "Letter_Portrait",
- "companyLogo": "string",
- "activityTypeCodes": [
- 0
], - "activityCodeLabel": "Value"
}0| notificationSubscriptionId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| global | boolean |
| id | integer <int64> |
| createdByUserId | string <uuid> |
Array of objects (NotificationSubscriptionRecipient) | |
| milestoneType | string Enum: "FULL_SCHEDULE" "PRIMARY_MILESTONE" "ALL_MILESTONES" "SELECTED_MILESTONES" |
| notificationType | string Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| notificationStatus | string Enum: "QUEUED" "IN_PROCESS" "COMPLETED" "FAILED" |
| subscriptionType | string Enum: "EMAIL_NOTIFICATION" "SMARTPM_DIGEST" |
Array of objects (SubscriptionDOW) | |
Array of objects (NotificationSubscriptionReport) | |
| skipAnalysisComplete | boolean |
| name | string |
| active | boolean |
| description | string |
Array of objects (NotificationSubscriptionCompanyFilter) | |
| modelType | string Enum: "ALL_SCHEDULES" "LATEST_BASELINE" "ALL_MODELS" |
{- "global": true,
- "id": 0,
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "notificationSubscriptionRecipients": [
- {
- "recipient": "string",
- "id": 0,
- "recipientType": "USER"
}
], - "milestoneType": "FULL_SCHEDULE",
- "notificationType": "ALL_ANALYSIS",
- "notificationStatus": "QUEUED",
- "subscriptionType": "EMAIL_NOTIFICATION",
- "subscriptionDOWs": [
- {
- "id": 0,
- "monday": true,
- "tuesday": true,
- "thursday": true,
- "wednesday": true,
- "friday": true,
- "saturday": true,
- "dowFrequency": "FIRST_OF_THE_MONTH",
- "sunday": true
}
], - "notificationSubscriptionReports": [
- {
- "id": 0,
- "reportTemplateId": 0
}
], - "skipAnalysisComplete": true,
- "name": "string",
- "active": true,
- "description": "string",
- "notificationSubscriptionCompanyFilters": [
- {
- "id": 0,
- "filterKey": "string",
- "filterValue": "string"
}
], - "modelType": "ALL_SCHEDULES"
}| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| description | string |
| notificationType | string Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| notificationStatus | string Enum: "QUEUED" "IN_PROCESS" "COMPLETED" "FAILED" |
| subscriptionType | string Enum: "EMAIL_NOTIFICATION" "SMARTPM_DIGEST" |
| milestoneType | string Enum: "FULL_SCHEDULE" "PRIMARY_MILESTONE" "ALL_MILESTONES" "SELECTED_MILESTONES" |
Array of objects (SubscriptionDOW) | |
| active | boolean |
| skipAnalysisComplete | boolean |
| modelType | string Enum: "ALL_SCHEDULES" "LATEST_BASELINE" "ALL_MODELS" |
Array of objects (NotificationSubscriptionCompanyFilter) | |
Array of objects (NotificationSubscriptionRecipient) | |
Array of objects (NotificationSubscriptionReport) |
{- "name": "string",
- "description": "string",
- "notificationType": "ALL_ANALYSIS",
- "notificationStatus": "QUEUED",
- "subscriptionType": "EMAIL_NOTIFICATION",
- "milestoneType": "FULL_SCHEDULE",
- "subscriptionDOWs": [
- {
- "id": 0,
- "monday": true,
- "tuesday": true,
- "thursday": true,
- "wednesday": true,
- "friday": true,
- "saturday": true,
- "dowFrequency": "FIRST_OF_THE_MONTH",
- "sunday": true
}
], - "active": true,
- "skipAnalysisComplete": true,
- "modelType": "ALL_SCHEDULES",
- "notificationSubscriptionCompanyFilters": [
- {
- "id": 0,
- "filterKey": "string",
- "filterValue": "string"
}
], - "notificationSubscriptionRecipients": [
- {
- "recipient": "string",
- "id": 0,
- "recipientType": "USER"
}
], - "notificationSubscriptionReports": [
- {
- "id": 0,
- "reportTemplateId": 0
}
]
}| reportTemplateId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| isArchived | boolean |
| reportVersion | string Enum: "V1" "V2" |
| reportConfig | string |
| reportLayout | string |
| name | string |
| id | integer <int64> |
| description | string |
| projectId | integer <int64> |
| outputType | string Enum: "PDF" "EXCEL" |
| createdByUserId | string <uuid> |
| reportType | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
{- "isArchived": true,
- "reportVersion": "V1",
- "reportConfig": "string",
- "reportLayout": "string",
- "name": "string",
- "id": 0,
- "description": "string",
- "projectId": 0,
- "outputType": "PDF",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "reportType": "CHANGES"
}| X-COMPANY-ID required | string The company's unique ID |
| isArchived | boolean |
| reportVersion | string Enum: "V1" "V2" |
| reportConfig | string |
| reportLayout | string |
| name | string |
| id | integer <int64> |
| description | string |
| projectId | integer <int64> |
| outputType | string Enum: "PDF" "EXCEL" |
| createdByUserId | string <uuid> |
| reportType | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
{- "isArchived": true,
- "reportVersion": "V1",
- "reportConfig": "string",
- "reportLayout": "string",
- "name": "string",
- "id": 0,
- "description": "string",
- "projectId": 0,
- "outputType": "PDF",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "reportType": "CHANGES"
}| sessionId required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| id | string <uuid> |
| lastModified | string <date-time> |
| projectId | integer <int64> |
| subject | string |
| agentType | string Enum: "FULL" "KB" |
| modelId | integer <int64> |
| archived | boolean |
| scenarioId | integer <int64> |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModified": "2019-08-24T14:15:22Z",
- "projectId": 0,
- "subject": "string",
- "agentType": "FULL",
- "modelId": 0,
- "archived": true,
- "scenarioId": 0
}| X-COMPANY-ID required | string The company's unique ID |
| id | string <uuid> |
| lastModified | string <date-time> |
| projectId | integer <int64> |
| subject | string |
| agentType | string Enum: "FULL" "KB" |
| modelId | integer <int64> |
| archived | boolean |
| scenarioId | integer <int64> |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModified": "2019-08-24T14:15:22Z",
- "projectId": 0,
- "subject": "string",
- "agentType": "FULL",
- "modelId": 0,
- "archived": true,
- "scenarioId": 0
}| type required | string Enum: "WORKSPACE" "DASHBOARD" |
| id required | string |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
| configuration required | string |
| reassignTemplateId | string |
| public | boolean |
{- "name": "string",
- "configuration": "string",
- "reassignTemplateId": "string",
- "public": true
}| type required | string Enum: "WORKSPACE" "DASHBOARD" |
| id required | string |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| templateId | string |
{- "templateId": "string"
}| type required | string Enum: "WORKSPACE" "DASHBOARD" |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| templateId | string |
{- "templateId": "string"
}| type required | string Enum: "WORKSPACE" "DASHBOARD" |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
| configuration required | string |
| reassignTemplateId | string |
| public | boolean |
{- "name": "string",
- "configuration": "string",
- "reassignTemplateId": "string",
- "public": true
}| type required | string Enum: "WORKSPACE" "DASHBOARD" |
| id required | string |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| userIds | Array of strings |
{- "userIds": [
- "string"
]
}| type required | string Enum: "WORKSPACE" "DASHBOARD" |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| templateId | string |
{- "templateId": "string"
}| userId required | string <uuid> |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| firstName | string |
| lastName | string |
string | |
| phoneNumber | string |
| title | string |
| role | string |
| ssoUser | boolean |
| disableNotification | boolean |
| reportingRestricted | boolean |
{- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "phoneNumber": "string",
- "title": "string",
- "role": "string",
- "ssoUser": true,
- "disableNotification": true,
- "reportingRestricted": true
}| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| firstName | string |
| lastName | string |
string | |
| phoneNumber | string |
| title | string |
| role | string |
| ssoUser | boolean |
| disableNotification | boolean |
| reportingRestricted | boolean |
{- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "phoneNumber": "string",
- "title": "string",
- "role": "string",
- "ssoUser": true,
- "disableNotification": true,
- "reportingRestricted": true
}Bulk import of users to the company, any invalid row fails the entire import and nothing is persisted
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| file required | string <binary> |
{- "file": "string"
}| userGroupId required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| userEmails | Array of strings |
{- "name": "string",
- "userEmails": [
- "string"
]
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| country | string |
| city | string |
| state | string |
| zipcode | string |
| latitude | number |
| longitude | number |
{- "name": "string",
- "country": "string",
- "city": "string",
- "state": "string",
- "zipcode": "string",
- "latitude": 0,
- "longitude": 0
}| projectId required | integer <int64> |
| noteId required | integer <int64> |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| note | string |
| category | string Enum: "PROJECT" "DELAY" "CHANGE" "MILESTONE" "CHECKLIST" |
| scenarioId | integer <int64> |
| dataDate | string <date-time> |
| projectNoteEntity | string Enum: "ACTIVITY" "LOGIC" "CALENDAR" "CALENDAR_WORKTIME" "CHECKLIST" "CHECKLIST_ITEM" |
| projectNoteEntityId | integer <int64> |
| projectNoteEntityLabel | string |
{- "note": "string",
- "category": "PROJECT",
- "scenarioId": 0,
- "dataDate": "2019-08-24T14:15:22Z",
- "projectNoteEntity": "ACTIVITY",
- "projectNoteEntityId": 0,
- "projectNoteEntityLabel": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| property name* | string |
{- "property1": "string",
- "property2": "string"
}| projectCreationType | string Default: "MANUAL" Enum: "MANUAL" "QUALITY_CHECK" "SCHEDULE_COMPARISON" "SCHEDULE_REVIEW" |
| filters | Array of strings |
| asOf | string |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| city | string |
| state | string |
| zipCode | string |
| country | string |
| latitude | number |
| longitude | number |
Array of objects (ProjectFileImportRequest) | |
| source | string Enum: "SmartPM" "XER" "MPP" "Excel" "PMXML" "PPX" "PP" |
| projectPlan | string |
object |
{- "name": "string",
- "city": "string",
- "state": "string",
- "zipCode": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "files": [
- {
- "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608",
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "name": "string",
- "dataDate": "2019-08-24T14:15:22Z",
- "contractualEndDate": "2019-08-24T14:15:22Z",
- "skipSubsetValidations": true,
- "importLogHitRateGoal": 0
}
], - "source": "SmartPM",
- "projectPlan": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| fileId | string <uuid> |
| name | string |
| dataDate | string <date-time> |
{- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "name": "string",
- "dataDate": "2019-08-24T14:15:22Z"
}| projectId required | integer <int64> |
| keepUnread | boolean |
| category | string Enum: "PROJECT" "DELAY" "CHANGE" "MILESTONE" "CHECKLIST" |
| scenarioId | integer <int64> |
| dataDate | string <date-time> |
| projectNoteEntity | string Enum: "ACTIVITY" "LOGIC" "CALENDAR" "CALENDAR_WORKTIME" "CHECKLIST" "CHECKLIST_ITEM" |
| projectNoteEntityId | integer <int64> |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| X-COMPANY-ID required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| note | string |
| category | string Enum: "PROJECT" "DELAY" "CHANGE" "MILESTONE" "CHECKLIST" |
| scenarioId | integer <int64> |
| dataDate | string <date-time> |
| projectNoteEntity | string Enum: "ACTIVITY" "LOGIC" "CALENDAR" "CALENDAR_WORKTIME" "CHECKLIST" "CHECKLIST_ITEM" |
| projectNoteEntityId | integer <int64> |
| projectNoteEntityLabel | string |
{- "note": "string",
- "category": "PROJECT",
- "scenarioId": 0,
- "dataDate": "2019-08-24T14:15:22Z",
- "projectNoteEntity": "ACTIVITY",
- "projectNoteEntityId": 0,
- "projectNoteEntityLabel": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| provider | string |
| externalId | string |
| externalCompanyId | string |
| externalBaseUrl | string |
| externalDetails | string |
{- "provider": "string",
- "externalId": "string",
- "externalCompanyId": "string",
- "externalBaseUrl": "string",
- "externalDetails": "string"
}| projectId required | integer <int64> |
| projectUserId required | integer <int64> |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| user | string |
| role | string |
| disableNotification | boolean |
{- "user": "string",
- "role": "string",
- "disableNotification": true
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| user | string |
| role | string |
| disableNotification | boolean |
{- "user": "string",
- "role": "string",
- "disableNotification": true
}| projectId required | integer <int64> |
| projectUserGroupId required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| userGroupId | string <uuid> |
| role | string |
| disableNotification | boolean |
{- "userGroupId": "080a16e0-8946-456c-aef9-504a239bc5ab",
- "role": "string",
- "disableNotification": true
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| userGroupId | string <uuid> |
| role | string |
| disableNotification | boolean |
{- "userGroupId": "080a16e0-8946-456c-aef9-504a239bc5ab",
- "role": "string",
- "disableNotification": true
}| projectId required | integer <int64> |
| submittalId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| externalProjectId | string External project Id |
| externalId | string External Id (provider's submittal record id) |
| number | string Submittal number |
| createdByEmail | string Email of the user who created the submittal |
| createdByUserName | string Name of the user who created the submittal |
| updatedDate | string <date-time> Updated date |
| scheduleImpactStatus | string Whether submittal impacts the schedule of the project or not |
| scheduleImpactValue | integer <int64> The number of days that the submittal impacts the schedule |
| costImpactStatus | string Whether submittal impacts the cost of the project or not |
| costImpactValue | number <double> The dollar amount that the submittal impacts the project |
| areLinkedActivitiesConfirmed | boolean Default: false Whether linked activities are confirmed |
| leadTime | integer <int64> Lead time (in days) |
| hasMultipleRevisions | boolean Default: false Whether the submittal has more than one revision |
| submitterStartDate | string <date-time> Submitter start date |
| submitterDueDate | string <date-time> Submitter due date |
| submitterReceivedDate | string <date-time> Submitter received date |
| processingStartDate | string <date-time> Processing start date |
| processingDueDate | string <date-time> Processing due date |
| processingSentDate | string <date-time> Processing sent date |
| approvalStartDate | string <date-time> Approval start date |
| approvalDueDate | string <date-time> Approval due date |
| approvalPublishedDate | string <date-time> Approval published date |
| requiredOnSiteDate | string <date-time> Required on site date |
| estimatedOnSiteDate | string <date-time> Estimated on site date |
object (SubmittalPackage) | |
object (SubmittalType) | |
Array of objects (SubmittalResponse) Submittal responses | |
Array of objects (SubmittalLinkedActivity) The list of activities linked and affected by the submittal | |
Array of objects (SubmittalBallInCourtUser) Ball in court users | |
| priority | string Priority |
| id | integer <int64> Submittal Id |
| providerName | string Enum: "AUTODESK" "PROCORE" "EGNYTE" "OPC" Name of 3rd party provider of submittal |
| description | string Submittal description |
| projectId required | integer <int64> SmartPM project Id |
| status | string Submittal status |
| userId | string <uuid> User Id |
| title | string Submittal title |
| createdDate | string <date-time> Created date |
{- "externalProjectId": "proj-7890",
- "externalId": "123",
- "number": "Submittal-2025-001",
- "createdByEmail": "john.smith@constructionco.com",
- "createdByUserName": "John Smith",
- "updatedDate": "2025-05-03T08:00:00.000Z",
- "scheduleImpactStatus": "yes",
- "scheduleImpactValue": 10,
- "costImpactStatus": "yes",
- "costImpactValue": 15000.75,
- "areLinkedActivitiesConfirmed": true,
- "leadTime": 10,
- "hasMultipleRevisions": true,
- "submitterStartDate": "2025-05-01T08:00:00.000Z",
- "submitterDueDate": "2025-05-05T08:00:00.000Z",
- "submitterReceivedDate": "2025-05-03T08:00:00.000Z",
- "processingStartDate": "2025-05-07T08:00:00.000Z",
- "processingDueDate": "2025-05-11T08:00:00.000Z",
- "processingSentDate": "2025-05-09T08:00:00.000Z",
- "approvalStartDate": "2025-05-13T08:00:00.000Z",
- "approvalDueDate": "2025-05-17T08:00:00.000Z",
- "approvalPublishedDate": "2025-05-15T08:00:00.000Z",
- "requiredOnSiteDate": "2025-05-15T08:00:00.000Z",
- "estimatedOnSiteDate": "2025-05-27T08:00:00.000Z",
- "submittalPackage": {
- "externalId": "proj-7890",
- "id": 1,
- "providerName": "AUTODESK",
- "description": "Structural steel connection details and fabrication drawings",
- "projectId": 2001,
- "title": "Structural Steel"
}, - "submittalType": {
- "externalId": "proj-7890",
- "name": "Shop drawing",
- "id": 1,
- "providerName": "AUTODESK",
- "projectId": 2001
}, - "submittalResponses": [
- {
- "createdByEmail": "jane.smith@constructionco.com",
- "createdByUserName": "Jane Smith",
- "updatedDate": "2025-10-29T14:30:00.000Z",
- "submittal": { },
- "id": 1,
- "response": "Approved as submitted",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "createdDate": "2025-10-27T14:30:00.000Z"
}
], - "submittalLinkedActivities": [
- {
- "submittal": { },
- "id": 1,
- "activityId": 25
}
], - "submittalBallInCourtUsers": [
- {
- "submittal": { },
- "name": "Michelle Wilson",
- "id": 501,
- "email": "michelle.wilson@constructionco.com"
}
], - "priority": "high",
- "id": 1001,
- "providerName": "AUTODESK",
- "description": "Detailed shop drawings for structural steel connections",
- "projectId": 2001,
- "status": "OPEN",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "title": "Structural Steel Details",
- "createdDate": "2025-05-01T08:00:00.000Z"
}| projectId required | integer <int64> |
| skipSubmittalActivityLinking | boolean Default: false |
| X-COMPANY-ID required | string The company's unique ID |
| externalProjectId | string External project Id |
| externalId | string External Id (provider's submittal record id) |
| number | string Submittal number |
| createdByEmail | string Email of the user who created the submittal |
| createdByUserName | string Name of the user who created the submittal |
| updatedDate | string <date-time> Updated date |
| scheduleImpactStatus | string Whether submittal impacts the schedule of the project or not |
| scheduleImpactValue | integer <int64> The number of days that the submittal impacts the schedule |
| costImpactStatus | string Whether submittal impacts the cost of the project or not |
| costImpactValue | number <double> The dollar amount that the submittal impacts the project |
| areLinkedActivitiesConfirmed | boolean Default: false Whether linked activities are confirmed |
| leadTime | integer <int64> Lead time (in days) |
| hasMultipleRevisions | boolean Default: false Whether the submittal has more than one revision |
| submitterStartDate | string <date-time> Submitter start date |
| submitterDueDate | string <date-time> Submitter due date |
| submitterReceivedDate | string <date-time> Submitter received date |
| processingStartDate | string <date-time> Processing start date |
| processingDueDate | string <date-time> Processing due date |
| processingSentDate | string <date-time> Processing sent date |
| approvalStartDate | string <date-time> Approval start date |
| approvalDueDate | string <date-time> Approval due date |
| approvalPublishedDate | string <date-time> Approval published date |
| requiredOnSiteDate | string <date-time> Required on site date |
| estimatedOnSiteDate | string <date-time> Estimated on site date |
object (SubmittalPackage) | |
object (SubmittalType) | |
Array of objects (SubmittalResponse) Submittal responses | |
Array of objects (SubmittalLinkedActivity) The list of activities linked and affected by the submittal | |
Array of objects (SubmittalBallInCourtUser) Ball in court users | |
| priority | string Priority |
| id | integer <int64> Submittal Id |
| providerName | string Enum: "AUTODESK" "PROCORE" "EGNYTE" "OPC" Name of 3rd party provider of submittal |
| description | string Submittal description |
| projectId required | integer <int64> SmartPM project Id |
| status | string Submittal status |
| userId | string <uuid> User Id |
| title | string Submittal title |
| createdDate | string <date-time> Created date |
{- "externalProjectId": "proj-7890",
- "externalId": "123",
- "number": "Submittal-2025-001",
- "createdByEmail": "john.smith@constructionco.com",
- "createdByUserName": "John Smith",
- "updatedDate": "2025-05-03T08:00:00.000Z",
- "scheduleImpactStatus": "yes",
- "scheduleImpactValue": 10,
- "costImpactStatus": "yes",
- "costImpactValue": 15000.75,
- "areLinkedActivitiesConfirmed": true,
- "leadTime": 10,
- "hasMultipleRevisions": true,
- "submitterStartDate": "2025-05-01T08:00:00.000Z",
- "submitterDueDate": "2025-05-05T08:00:00.000Z",
- "submitterReceivedDate": "2025-05-03T08:00:00.000Z",
- "processingStartDate": "2025-05-07T08:00:00.000Z",
- "processingDueDate": "2025-05-11T08:00:00.000Z",
- "processingSentDate": "2025-05-09T08:00:00.000Z",
- "approvalStartDate": "2025-05-13T08:00:00.000Z",
- "approvalDueDate": "2025-05-17T08:00:00.000Z",
- "approvalPublishedDate": "2025-05-15T08:00:00.000Z",
- "requiredOnSiteDate": "2025-05-15T08:00:00.000Z",
- "estimatedOnSiteDate": "2025-05-27T08:00:00.000Z",
- "submittalPackage": {
- "externalId": "proj-7890",
- "id": 1,
- "providerName": "AUTODESK",
- "description": "Structural steel connection details and fabrication drawings",
- "projectId": 2001,
- "title": "Structural Steel"
}, - "submittalType": {
- "externalId": "proj-7890",
- "name": "Shop drawing",
- "id": 1,
- "providerName": "AUTODESK",
- "projectId": 2001
}, - "submittalResponses": [
- {
- "createdByEmail": "jane.smith@constructionco.com",
- "createdByUserName": "Jane Smith",
- "updatedDate": "2025-10-29T14:30:00.000Z",
- "submittal": { },
- "id": 1,
- "response": "Approved as submitted",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "createdDate": "2025-10-27T14:30:00.000Z"
}
], - "submittalLinkedActivities": [
- {
- "submittal": { },
- "id": 1,
- "activityId": 25
}
], - "submittalBallInCourtUsers": [
- {
- "submittal": { },
- "name": "Michelle Wilson",
- "id": 501,
- "email": "michelle.wilson@constructionco.com"
}
], - "priority": "high",
- "id": 1001,
- "providerName": "AUTODESK",
- "description": "Detailed shop drawings for structural steel connections",
- "projectId": 2001,
- "status": "OPEN",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "title": "Structural Steel Details",
- "createdDate": "2025-05-01T08:00:00.000Z"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| activityCodeTypeId required | integer <int64> |
| activityCodeId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
[- 0
]| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| activityCodeTypeMappingType required | string Enum: "TRADE" "WEATHER_SUSCEPTIBILITY" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| rfiId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| externalProjectId | string External project ID |
| externalId | string External ID (provider's RFI record id) |
Array of objects (RfiQuestion) RFI questions | |
| number | string RFI number |
| createdByEmail | string Email of the user who created the RFI |
| createdByUserName | string Name of the user who created the RFI |
| dueDate | string <date-time> Due date |
| updatedDate | string <date-time> Updated date |
| resolvedDate | string <date-time> Date when RFI was resolved |
| scheduleImpactStatus | string Whether RFI impacts the schedule of the project or not |
| scheduleImpactValue | integer <int64> The number of days that the RFI impacts the schedule |
| costImpactStatus | string Whether RFI impacts the cost of the project or not |
| costImpactValue | number <double> The dollar amount that the RFI impacts the project |
| areLinkedActivitiesConfirmed | boolean Default: false Whether linked activities are confirmed |
Array of objects (RfiLinkedActivity) The list of activities linked and affected by the RFI | |
Array of objects (RfiBallInCourtUser) Ball in court users | |
Array of objects (RfiStage) Ongoing and Completed stages of RFI | |
| currentStageType | string Enum: "SUBMITTED" "OPEN" "CLOSED" "WITHDRAWN" Current stage type of RFI |
| predictionId | string <uuid> ai-api prediction that linked the activities |
| lastResponseDate | string <date-time> |
| location | string Location |
| priority | string Priority |
| id | integer <int64> RFI ID |
| providerName | string Enum: "AUTODESK" "PROCORE" "EGNYTE" "OPC" Name of 3rd party provider of RFI |
| projectId required | integer <int64> Project ID |
| status | string Rfi Status |
| userId | string <uuid> User ID |
| title | string Title |
| createdDate | string <date-time> Created date |
{- "externalProjectId": "proj-7890",
- "externalId": "123",
- "rfiQuestions": [
- {
- "rfi": { },
- "rfiAnswers": [
- {
- "createdByEmail": "bob.jones@constructionco.com",
- "createdByUserName": "Bob Jones",
- "id": 301,
- "rfiQuestion": { },
- "answer": "Yes, with accelerated scheduling, completion is feasible by mid-April.",
- "isOfficialResponse": true,
- "userId": "123e4567-e89b-12d3-a456-426614174002",
- "createdDate": "2025-05-02T10:15:00.000Z"
}
], - "createdByUserName": "John Doe",
- "id": 401,
- "question": "Can the foundation work be completed before the rainy season?",
- "userId": "123e4567-e89b-12d3-a456-426614174001",
- "createdDate": "2025-05-01T14:30:00.000Z"
}
], - "number": "RFI-2025-001",
- "createdByEmail": "jane.smith@constructionco.com",
- "createdByUserName": "Jane Smith",
- "dueDate": "2025-05-10T17:00:00.000Z",
- "updatedDate": "2025-05-03T16:20:00.000Z",
- "resolvedDate": "2025-05-04T09:42:00.000Z",
- "scheduleImpactStatus": "yes",
- "scheduleImpactValue": 10,
- "costImpactStatus": "yes",
- "costImpactValue": 15000.75,
- "areLinkedActivitiesConfirmed": true,
- "rfiLinkedActivities": [
- {
- "rfi": { },
- "id": 1,
- "activityId": 25
}
], - "rfiBallInCourtUsers": [
- {
- "rfi": { },
- "name": "Mike Wilson",
- "id": 501,
- "email": "mike.wilson@constructionco.com"
}
], - "rfiStages": [
- {
- "id": 0,
- "type": "SUBMITTED",
- "index": 0,
- "actors": [
- {
- "updatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "id": 0,
- "actionCompleted": true,
- "email": "string"
}
], - "initialMessage": "string",
- "completionMessage": "string",
- "completionDateLabel": "string",
- "completionDate": "2019-08-24T14:15:22Z"
}
], - "currentStageType": "OPEN",
- "predictionId": "3f2b8c1e-0000-4000-8000-000000000000",
- "lastResponseDate": "2019-08-24T14:15:22Z",
- "location": "Building A, Floor 3",
- "priority": "high",
- "id": 1001,
- "providerName": "AUTODESK",
- "projectId": 2001,
- "status": "OPEN",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "title": "Foundation Work Schedule Clarification",
- "createdDate": "2025-05-01T08:00:00.000Z"
}| projectId required | integer <int64> |
| skipRfiActivityLinking | boolean Default: false |
| X-COMPANY-ID required | string The company's unique ID |
| externalProjectId | string External project ID |
| externalId | string External ID (provider's RFI record id) |
Array of objects (RfiQuestion) RFI questions | |
| number | string RFI number |
| createdByEmail | string Email of the user who created the RFI |
| createdByUserName | string Name of the user who created the RFI |
| dueDate | string <date-time> Due date |
| updatedDate | string <date-time> Updated date |
| resolvedDate | string <date-time> Date when RFI was resolved |
| scheduleImpactStatus | string Whether RFI impacts the schedule of the project or not |
| scheduleImpactValue | integer <int64> The number of days that the RFI impacts the schedule |
| costImpactStatus | string Whether RFI impacts the cost of the project or not |
| costImpactValue | number <double> The dollar amount that the RFI impacts the project |
| areLinkedActivitiesConfirmed | boolean Default: false Whether linked activities are confirmed |
Array of objects (RfiLinkedActivity) The list of activities linked and affected by the RFI | |
Array of objects (RfiBallInCourtUser) Ball in court users | |
Array of objects (RfiStage) Ongoing and Completed stages of RFI | |
| currentStageType | string Enum: "SUBMITTED" "OPEN" "CLOSED" "WITHDRAWN" Current stage type of RFI |
| predictionId | string <uuid> ai-api prediction that linked the activities |
| lastResponseDate | string <date-time> |
| location | string Location |
| priority | string Priority |
| id | integer <int64> RFI ID |
| providerName | string Enum: "AUTODESK" "PROCORE" "EGNYTE" "OPC" Name of 3rd party provider of RFI |
| projectId required | integer <int64> Project ID |
| status | string Rfi Status |
| userId | string <uuid> User ID |
| title | string Title |
| createdDate | string <date-time> Created date |
{- "externalProjectId": "proj-7890",
- "externalId": "123",
- "rfiQuestions": [
- {
- "rfi": { },
- "rfiAnswers": [
- {
- "createdByEmail": "bob.jones@constructionco.com",
- "createdByUserName": "Bob Jones",
- "id": 301,
- "rfiQuestion": { },
- "answer": "Yes, with accelerated scheduling, completion is feasible by mid-April.",
- "isOfficialResponse": true,
- "userId": "123e4567-e89b-12d3-a456-426614174002",
- "createdDate": "2025-05-02T10:15:00.000Z"
}
], - "createdByUserName": "John Doe",
- "id": 401,
- "question": "Can the foundation work be completed before the rainy season?",
- "userId": "123e4567-e89b-12d3-a456-426614174001",
- "createdDate": "2025-05-01T14:30:00.000Z"
}
], - "number": "RFI-2025-001",
- "createdByEmail": "jane.smith@constructionco.com",
- "createdByUserName": "Jane Smith",
- "dueDate": "2025-05-10T17:00:00.000Z",
- "updatedDate": "2025-05-03T16:20:00.000Z",
- "resolvedDate": "2025-05-04T09:42:00.000Z",
- "scheduleImpactStatus": "yes",
- "scheduleImpactValue": 10,
- "costImpactStatus": "yes",
- "costImpactValue": 15000.75,
- "areLinkedActivitiesConfirmed": true,
- "rfiLinkedActivities": [
- {
- "rfi": { },
- "id": 1,
- "activityId": 25
}
], - "rfiBallInCourtUsers": [
- {
- "rfi": { },
- "name": "Mike Wilson",
- "id": 501,
- "email": "mike.wilson@constructionco.com"
}
], - "rfiStages": [
- {
- "id": 0,
- "type": "SUBMITTED",
- "index": 0,
- "actors": [
- {
- "updatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "id": 0,
- "actionCompleted": true,
- "email": "string"
}
], - "initialMessage": "string",
- "completionMessage": "string",
- "completionDateLabel": "string",
- "completionDate": "2019-08-24T14:15:22Z"
}
], - "currentStageType": "OPEN",
- "predictionId": "3f2b8c1e-0000-4000-8000-000000000000",
- "lastResponseDate": "2019-08-24T14:15:22Z",
- "location": "Building A, Floor 3",
- "priority": "high",
- "id": 1001,
- "providerName": "AUTODESK",
- "projectId": 2001,
- "status": "OPEN",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "title": "Foundation Work Schedule Clarification",
- "createdDate": "2025-05-01T08:00:00.000Z"
}| projectId required | integer <int64> |
| modelId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| id | integer <int64> |
| name | string |
| projectId | integer <int64> |
| description | string |
| isAutoUpdate | boolean |
| isOriginalModel | boolean |
| isArchived | boolean |
| modelImportLogIds | Array of integers <int64> |
| modelBaseRuleIds | Array of integers <int64> |
| modelType | string Enum: "BASELINE" "ADVANCED_MODEL" "TEST_WORKWEEK" "REMOVE_RESOURCES" "EXCLUDE_PROGRESS" |
| initialDataDate | string <date-time> |
| status | string Enum: "COMPLETE" "PENDING_DELETION" "PROCESSING" |
{- "id": 0,
- "name": "string",
- "projectId": 0,
- "description": "string",
- "isAutoUpdate": true,
- "isOriginalModel": true,
- "isArchived": true,
- "modelImportLogIds": [
- 0
], - "modelBaseRuleIds": [
- 0
], - "modelType": "BASELINE",
- "initialDataDate": "2019-08-24T14:15:22Z",
- "status": "COMPLETE"
}| projectId required | integer <int64> |
| modelId required | integer <int64> |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| scheduleIds | Array of integers <int64> |
{- "scheduleIds": [
- 0
]
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string |
| description | string |
| scheduleIds required | Array of integers <int64> non-empty |
| ruleIds required | Array of integers <int64> |
| activityIds required | Array of integers <int64> |
| isAutoUpdate | boolean |
| modelType required | string Enum: "BASELINE" "ADVANCED_MODEL" "TEST_WORKWEEK" "REMOVE_RESOURCES" "EXCLUDE_PROGRESS" |
{- "name": "string",
- "description": "string",
- "scheduleIds": [
- 0
], - "ruleIds": [
- 0
], - "activityIds": [
- 0
], - "isAutoUpdate": true,
- "modelType": "BASELINE"
}| projectId required | integer <int64> |
| modelId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
{- "name": "string"
}| metadataId required | integer <int64> |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| apiName | string |
| name | string |
| id | integer <int64> |
| type | string |
| defaultValue | string |
| required | boolean |
| companyId | string |
| displayOrder | integer <int32> |
| uniqueKey | string |
{- "apiName": "string",
- "name": "string",
- "id": 0,
- "type": "string",
- "defaultValue": "string",
- "required": true,
- "companyId": "string",
- "displayOrder": 0,
- "uniqueKey": "string"
}| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
Array of ProjectMetadataDateField (object) or ProjectMetadataDropdownField (object) or ProjectMetadataNumericField (object) or ProjectMetadataTextField (object) |
{- "projectMetadatas": [
- {
- "apiName": "string",
- "name": "string",
- "id": 0,
- "type": "string",
- "defaultValue": "string",
- "required": true,
- "companyId": "string",
- "displayOrder": 0,
- "uniqueKey": "string"
}
]
}| metadataKey required | string |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| type | string Enum: "LOWEST_HEALTH" "LOWEST_QUALITY" "MOST_COMPRESSED" |
| count | integer <int32> |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| scope required | string Enum: "SCENARIO" "COMPANY" |
| configuration required | string |
| X-COMPANY-ID required | string The company's unique ID |
| setting | string |
{- "setting": "string"
}| projectId required | integer <int64> |
| wbsId required | integer <int32> |
| X-COMPANY-ID required | string The company's unique ID |
| parentWBSId | integer <int32> |
| sequenceNumber | integer <int32> |
| code | string |
| name | string |
| startDate | string <date> |
| endDate | string <date> |
{- "parentWBSId": 0,
- "sequenceNumber": 0,
- "code": "string",
- "name": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| parentWBSId | integer <int32> |
| sequenceNumber | integer <int32> |
| code | string |
| name | string |
| startDate | string <date> |
| endDate | string <date> |
{- "parentWBSId": 0,
- "sequenceNumber": 0,
- "code": "string",
- "name": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| scheduleIds | Array of integers <int64> |
| ruleIds | Array of integers <int64> |
| autoUpdate | boolean |
| requester | string |
| requesterCompanyName | string |
| name | string |
| description | string |
| aiTenantId | string |
{- "scheduleIds": [
- 0
], - "ruleIds": [
- 0
], - "autoUpdate": true,
- "requester": "string",
- "requesterCompanyName": "string",
- "name": "string",
- "description": "string",
- "aiTenantId": "string"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| scheduleIds | Array of integers <int64> |
{- "scheduleIds": [
- 0
]
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
{- "name": "string"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| displayOrder | integer <int32> |
{- "displayOrder": 0
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| dataDate | string |
| startDate required | string |
| endDate required | string |
| floatMin | number <double> |
| floatMax | number <double> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| scenarioId required | integer <int64> |
| projectId required | integer <int64> |
| importLogId required | integer <int64> |
| importLogChecklistId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogChecklistId | integer <int64> |
| locked | boolean |
| autoCheckComplete | boolean |
{- "importLogChecklistId": 0,
- "locked": true,
- "autoCheckComplete": true
}| scenarioId required | integer <int64> |
| projectId required | integer <int64> |
| importLogId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| scenarioId | integer <int64> |
| importLogId | integer <int64> |
| checklistId | integer <int64> |
Array of objects (ImportLogChecklistItemRequest) |
{- "scenarioId": 0,
- "importLogId": 0,
- "checklistId": 0,
- "importLogChecklistItemRequests": [
- {
- "importLogChecklistItemId": 0,
- "value": "UNDEFINED",
- "importLogChecklistId": 0,
- "checklistSectionItemId": 0,
- "importLogChecklistItemDetailRequests": [
- {
- "importLogChecklistItemDetailId": 0,
- "importLogChecklistItemId": 0,
- "detail": "string"
}
]
}
]
}| scenarioId required | integer <int64> |
| projectId required | integer <int64> |
| importLogId required | integer <int64> |
| importLogChecklistItemId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogChecklistItemId | integer <int64> |
| value | string Enum: "UNDEFINED" "YES" "NO" |
| importLogChecklistId | integer <int64> |
| checklistSectionItemId | integer <int64> |
Array of objects (ImportLogChecklistItemDetailRequest) |
{- "importLogChecklistItemId": 0,
- "value": "UNDEFINED",
- "importLogChecklistId": 0,
- "checklistSectionItemId": 0,
- "importLogChecklistItemDetailRequests": [
- {
- "importLogChecklistItemDetailId": 0,
- "importLogChecklistItemId": 0,
- "detail": "string"
}
]
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| id | integer <int64> |
| name required | string non-empty |
| isAnd | boolean |
| type | string Enum: "Company" "CustomReport" "Delay" "Manual" "Rule" "Temporary" |
Array of objects (QueryUpdateRequest) | |
Array of objects (FilterUpdateRequest) | |
| and | boolean |
{- "id": 0,
- "name": "string",
- "isAnd": true,
- "type": "Company",
- "queries": [
- {
- "attribute": 0,
- "operator": 0,
- "value": "string",
- "hvalue": "string",
- "id": 0
}
], - "subFilters": [
- { }
], - "and": true
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
| isAnd | boolean |
| type | string Enum: "Company" "CustomReport" "Delay" "Manual" "Rule" "Temporary" |
Array of objects (QueryAddRequest) | |
Array of objects (FilterCreateRequest) | |
Array of objects (FilterCreateRequest) |
{- "name": "string",
- "isAnd": true,
- "type": "Company",
- "queries": [
- {
- "attribute": 0,
- "operator": 0,
- "value": "string",
- "hvalue": "string"
}
], - "subFilters": [
- { }
], - "filters": [
- { }
]
}| projectId required | integer <int64> |
| ruleId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| id | integer <int64> |
| type | string |
| importLogId | integer <int64> |
Array of objects (BulkChangeItem) | |
Array of objects (BulkChangeExclusion) | |
| filterId | integer <int64> |
{- "name": "string",
- "id": 0,
- "type": "string",
- "importLogId": 0,
- "bulkChangeItems": [
- {
- "valueType": "VALUE",
- "field": "string",
- "id": 0,
- "newValue": "string"
}
], - "bulkChangeExclusions": [
- {
- "id": 0,
- "activityId": 0
}
], - "filterId": 0
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| id | integer <int64> |
| type | string |
| importLogId | integer <int64> |
Array of objects (BulkChangeItem) | |
Array of objects (BulkChangeExclusion) | |
| filterId | integer <int64> |
{- "name": "string",
- "id": 0,
- "type": "string",
- "importLogId": 0,
- "bulkChangeItems": [
- {
- "valueType": "VALUE",
- "field": "string",
- "id": 0,
- "newValue": "string"
}
], - "bulkChangeExclusions": [
- {
- "id": 0,
- "activityId": 0
}
], - "filterId": 0
}| projectId required | integer <int64> |
| reportTemplateId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| isArchived | boolean |
| reportVersion | string Enum: "V1" "V2" |
| reportConfig | string |
| reportLayout | string |
| name | string |
| id | integer <int64> |
| description | string |
| projectId | integer <int64> |
| outputType | string Enum: "PDF" "EXCEL" |
| createdByUserId | string <uuid> |
| reportType | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
{- "isArchived": true,
- "reportVersion": "V1",
- "reportConfig": "string",
- "reportLayout": "string",
- "name": "string",
- "id": 0,
- "description": "string",
- "projectId": 0,
- "outputType": "PDF",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "reportType": "CHANGES"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| isArchived | boolean |
| reportVersion | string Enum: "V1" "V2" |
| reportConfig | string |
| reportLayout | string |
| name | string |
| id | integer <int64> |
| description | string |
| projectId | integer <int64> |
| outputType | string Enum: "PDF" "EXCEL" |
| createdByUserId | string <uuid> |
| reportType | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
{- "isArchived": true,
- "reportVersion": "V1",
- "reportConfig": "string",
- "reportLayout": "string",
- "name": "string",
- "id": 0,
- "description": "string",
- "projectId": 0,
- "outputType": "PDF",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "reportType": "CHANGES"
}| projectId required | integer <int64> |
| notificationSubscriptionId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (NotificationSubscriptionScenario) | |
| projectId | integer <int64> |
| id | integer <int64> |
| createdByUserId | string <uuid> |
Array of objects (NotificationSubscriptionRecipient) | |
| milestoneType | string Enum: "FULL_SCHEDULE" "PRIMARY_MILESTONE" "ALL_MILESTONES" "SELECTED_MILESTONES" |
| notificationType | string Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| notificationStatus | string Enum: "QUEUED" "IN_PROCESS" "COMPLETED" "FAILED" |
| subscriptionType | string Enum: "EMAIL_NOTIFICATION" "SMARTPM_DIGEST" |
Array of objects (SubscriptionDOW) | |
Array of objects (NotificationSubscriptionReport) | |
| skipAnalysisComplete | boolean |
| name | string |
| active | boolean |
| description | string |
{- "notificationSubscriptionScenarios": [
- {
- "id": 0,
- "scenarioId": 0
}
], - "projectId": 0,
- "id": 0,
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "notificationSubscriptionRecipients": [
- {
- "recipient": "string",
- "id": 0,
- "recipientType": "USER"
}
], - "milestoneType": "FULL_SCHEDULE",
- "notificationType": "ALL_ANALYSIS",
- "notificationStatus": "QUEUED",
- "subscriptionType": "EMAIL_NOTIFICATION",
- "subscriptionDOWs": [
- {
- "id": 0,
- "monday": true,
- "tuesday": true,
- "thursday": true,
- "wednesday": true,
- "friday": true,
- "saturday": true,
- "dowFrequency": "FIRST_OF_THE_MONTH",
- "sunday": true
}
], - "notificationSubscriptionReports": [
- {
- "id": 0,
- "reportTemplateId": 0
}
], - "skipAnalysisComplete": true,
- "name": "string",
- "active": true,
- "description": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| description | string |
| notificationType | string Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| notificationStatus | string Enum: "QUEUED" "IN_PROCESS" "COMPLETED" "FAILED" |
| subscriptionType | string Enum: "EMAIL_NOTIFICATION" "SMARTPM_DIGEST" |
| milestoneType | string Enum: "FULL_SCHEDULE" "PRIMARY_MILESTONE" "ALL_MILESTONES" "SELECTED_MILESTONES" |
Array of objects (SubscriptionDOW) | |
| active | boolean |
| skipAnalysisComplete | boolean |
Array of objects (NotificationSubscriptionScenario) | |
Array of objects (NotificationSubscriptionRecipient) | |
Array of objects (NotificationSubscriptionReport) |
{- "name": "string",
- "description": "string",
- "notificationType": "ALL_ANALYSIS",
- "notificationStatus": "QUEUED",
- "subscriptionType": "EMAIL_NOTIFICATION",
- "milestoneType": "FULL_SCHEDULE",
- "subscriptionDOWs": [
- {
- "id": 0,
- "monday": true,
- "tuesday": true,
- "thursday": true,
- "wednesday": true,
- "friday": true,
- "saturday": true,
- "dowFrequency": "FIRST_OF_THE_MONTH",
- "sunday": true
}
], - "active": true,
- "skipAnalysisComplete": true,
- "notificationSubscriptionScenarios": [
- {
- "id": 0,
- "scenarioId": 0
}
], - "notificationSubscriptionRecipients": [
- {
- "recipient": "string",
- "id": 0,
- "recipientType": "USER"
}
], - "notificationSubscriptionReports": [
- {
- "id": 0,
- "reportTemplateId": 0
}
]
}| projectId required | integer <int64> |
| importLogHitRateGoalId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| id | integer <int64> |
| importLogHitRateGoalValue | integer <int32> |
| importLogId | integer <int64> |
{- "id": 0,
- "importLogHitRateGoalValue": 0,
- "importLogId": 0
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| id | integer <int64> |
| importLogHitRateGoalValue | integer <int32> |
| importLogId | integer <int64> |
{- "id": 0,
- "importLogHitRateGoalValue": 0,
- "importLogId": 0
}| projectId required | integer <int64> |
| filterId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| id | integer <int64> |
| name required | string non-empty |
| isAnd | boolean |
| type | string Enum: "Company" "CustomReport" "Delay" "Manual" "Rule" "Temporary" |
Array of objects (QueryUpdateRequest) | |
Array of objects (FilterUpdateRequest) | |
| and | boolean |
{- "id": 0,
- "name": "string",
- "isAnd": true,
- "type": "Company",
- "queries": [
- {
- "attribute": 0,
- "operator": 0,
- "value": "string",
- "hvalue": "string",
- "id": 0
}
], - "subFilters": [
- { }
], - "and": true
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
| isAnd | boolean |
| type | string Enum: "Company" "CustomReport" "Delay" "Manual" "Rule" "Temporary" |
Array of objects (QueryAddRequest) | |
Array of objects (FilterCreateRequest) | |
Array of objects (FilterCreateRequest) |
{- "name": "string",
- "isAnd": true,
- "type": "Company",
- "queries": [
- {
- "attribute": 0,
- "operator": 0,
- "value": "string",
- "hvalue": "string"
}
], - "subFilters": [
- { }
], - "filters": [
- { }
]
}| projectId required | integer <int64> |
| calendarId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
Array of objects (WorktimeAddRequest) | |
| type | string |
| hoursPerDay | number <double> |
| hoursPerWeek | number <double> |
| hoursPerMonth | number <double> |
| hoursPerYear | number <double> |
{- "name": "string",
- "worktimes": [
- {
- "id": 0,
- "dayOfWeek": 0,
- "specificDate": "2019-08-24",
- "hours": 0,
- "isHoliday": true,
- "timeStart1": "string",
- "timeEnd1": "string",
- "timeStart2": "string",
- "timeEnd2": "string",
- "timeStart3": "string",
- "timeEnd3": "string",
- "timeStart4": "string",
- "timeEnd4": "string",
- "timeStart5": "string",
- "timeEnd5": "string"
}
], - "type": "string",
- "hoursPerDay": 0,
- "hoursPerWeek": 0,
- "hoursPerMonth": 0,
- "hoursPerYear": 0
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
Array of objects (WorktimeAddRequest) | |
| type | string |
| hoursPerDay | number <double> |
| hoursPerWeek | number <double> |
| hoursPerMonth | number <double> |
| hoursPerYear | number <double> |
{- "name": "string",
- "worktimes": [
- {
- "id": 0,
- "dayOfWeek": 0,
- "specificDate": "2019-08-24",
- "hours": 0,
- "isHoliday": true,
- "timeStart1": "string",
- "timeEnd1": "string",
- "timeStart2": "string",
- "timeEnd2": "string",
- "timeStart3": "string",
- "timeEnd3": "string",
- "timeStart4": "string",
- "timeEnd4": "string",
- "timeStart5": "string",
- "timeEnd5": "string"
}
], - "type": "string",
- "hoursPerDay": 0,
- "hoursPerWeek": 0,
- "hoursPerMonth": 0,
- "hoursPerYear": 0
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (ActivityCodeOrderRequest) |
{- "orders": [
- {
- "activityCodeId": 0,
- "activityCodeTypeId": 0,
- "order": 0
}
]
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| parentId | integer <int64> |
| activityCodeTypeId required | integer <int64> >= 1 |
| value | string |
| desc | string |
| sequenceNumber | integer <int32> >= 1 |
| order | integer <int32> >= 0 |
{- "parentId": 0,
- "activityCodeTypeId": 1,
- "value": "string",
- "desc": "string",
- "sequenceNumber": 1,
- "order": 0
}| activityCodeId required | integer <int64> |
| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| activityCodeTypeId required | integer <int64> >= 1 |
| value required | string |
| desc | string |
| sequenceNumber | integer <int32> >= 1 |
| order | integer <int32> >= 0 |
{- "activityCodeTypeId": 1,
- "value": "string",
- "desc": "string",
- "sequenceNumber": 1,
- "order": 0
}| projectId required | integer <int64> |
| activityCodeTypeId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string |
{- "name": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| sequenceNumber | integer <int32> >= 1 |
| isSecureCode | boolean |
| length | integer <int32> >= 1 |
| name required | string |
| scope required | string |
| epsId | integer <int32> |
| epsNumber | integer <int32> |
{- "sequenceNumber": 1,
- "isSecureCode": true,
- "length": 1,
- "name": "string",
- "scope": "string",
- "epsId": 0,
- "epsNumber": 0
}| providerAuthId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| providerAuthId | integer <int64> |
Array of objects (ProviderData) |
{- "providerAuthId": 0,
- "providerDataList": [
- {
- "dataType": "RFI",
- "id": 0,
- "providerConfig": "string"
}
]
}| notificationSubscriptionId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| global | boolean |
| id | integer <int64> |
| createdByUserId | string <uuid> |
Array of objects (NotificationSubscriptionRecipient) | |
| milestoneType | string Enum: "FULL_SCHEDULE" "PRIMARY_MILESTONE" "ALL_MILESTONES" "SELECTED_MILESTONES" |
| notificationType | string Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| notificationStatus | string Enum: "QUEUED" "IN_PROCESS" "COMPLETED" "FAILED" |
| subscriptionType | string Enum: "EMAIL_NOTIFICATION" "SMARTPM_DIGEST" |
Array of objects (SubscriptionDOW) | |
Array of objects (NotificationSubscriptionReport) | |
| skipAnalysisComplete | boolean |
| name | string |
| active | boolean |
| description | string |
Array of objects (NotificationSubscriptionCompanyFilter) | |
| modelType | string Enum: "ALL_SCHEDULES" "LATEST_BASELINE" "ALL_MODELS" |
{- "global": true,
- "id": 0,
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "notificationSubscriptionRecipients": [
- {
- "recipient": "string",
- "id": 0,
- "recipientType": "USER"
}
], - "milestoneType": "FULL_SCHEDULE",
- "notificationType": "ALL_ANALYSIS",
- "notificationStatus": "QUEUED",
- "subscriptionType": "EMAIL_NOTIFICATION",
- "subscriptionDOWs": [
- {
- "id": 0,
- "monday": true,
- "tuesday": true,
- "thursday": true,
- "wednesday": true,
- "friday": true,
- "saturday": true,
- "dowFrequency": "FIRST_OF_THE_MONTH",
- "sunday": true
}
], - "notificationSubscriptionReports": [
- {
- "id": 0,
- "reportTemplateId": 0
}
], - "skipAnalysisComplete": true,
- "name": "string",
- "active": true,
- "description": "string",
- "notificationSubscriptionCompanyFilters": [
- {
- "id": 0,
- "filterKey": "string",
- "filterValue": "string"
}
], - "modelType": "ALL_SCHEDULES"
}| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| description | string |
| notificationType | string Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| notificationStatus | string Enum: "QUEUED" "IN_PROCESS" "COMPLETED" "FAILED" |
| subscriptionType | string Enum: "EMAIL_NOTIFICATION" "SMARTPM_DIGEST" |
| milestoneType | string Enum: "FULL_SCHEDULE" "PRIMARY_MILESTONE" "ALL_MILESTONES" "SELECTED_MILESTONES" |
Array of objects (SubscriptionDOW) | |
| active | boolean |
| skipAnalysisComplete | boolean |
| modelType | string Enum: "ALL_SCHEDULES" "LATEST_BASELINE" "ALL_MODELS" |
Array of objects (NotificationSubscriptionCompanyFilter) | |
Array of objects (NotificationSubscriptionRecipient) | |
Array of objects (NotificationSubscriptionReport) |
{- "name": "string",
- "description": "string",
- "notificationType": "ALL_ANALYSIS",
- "notificationStatus": "QUEUED",
- "subscriptionType": "EMAIL_NOTIFICATION",
- "milestoneType": "FULL_SCHEDULE",
- "subscriptionDOWs": [
- {
- "id": 0,
- "monday": true,
- "tuesday": true,
- "thursday": true,
- "wednesday": true,
- "friday": true,
- "saturday": true,
- "dowFrequency": "FIRST_OF_THE_MONTH",
- "sunday": true
}
], - "active": true,
- "skipAnalysisComplete": true,
- "modelType": "ALL_SCHEDULES",
- "notificationSubscriptionCompanyFilters": [
- {
- "id": 0,
- "filterKey": "string",
- "filterValue": "string"
}
], - "notificationSubscriptionRecipients": [
- {
- "recipient": "string",
- "id": 0,
- "recipientType": "USER"
}
], - "notificationSubscriptionReports": [
- {
- "id": 0,
- "reportTemplateId": 0
}
]
}| riskProfileId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| scoreReporting | string Value: "NUMBER" |
Array of objects (RiskThreshold) | |
| name | string |
| id | integer <int64> |
| version | integer <int32> |
object | |
| companyId | string <uuid> |
| archived | boolean |
| createdDate | string <date-time> |
{- "scoreReporting": "NUMBER",
- "riskThresholds": [
- {
- "isHidden": true,
- "id": 0,
- "weight": 0,
- "values": [
- {
- "value": 0,
- "id": 0,
- "indicator": "GOOD"
}
], - "metric": "LOW_FLOAT_RISK"
}
], - "name": "string",
- "id": 0,
- "version": 0,
- "configuration": {
- "property1": {
- "value": "string",
- "methodType": "STATIC"
}, - "property2": {
- "value": "string",
- "methodType": "STATIC"
}
}, - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "archived": true,
- "createdDate": "2019-08-24T14:15:22Z"
}| companyId required | string |
| qualityProfileId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| scoreReporting | string Enum: "Letter" "Color" "Number" |
Array of objects (QualityThreshold) | |
| name | string |
| id | integer <int64> |
| version | integer <int32> |
object | |
| companyId | string <uuid> |
| createdDate | string <date-time> |
{- "scoreReporting": "Letter",
- "qualityThreshold": [
- {
- "impactType": "MIXED",
- "fineImpact": 0,
- "badImpact": 0,
- "evaluationTarget": "PERCENTAGE",
- "isHidden": true,
- "id": 0,
- "values": [
- {
- "value": 0,
- "id": 0,
- "indicator": "GOOD"
}
], - "filters": [
- {
- "value": "string",
- "field": "string",
- "id": 0,
- "entity": "Activity",
- "operator": "EQUALS"
}
], - "metric": "ACTIVITIES_TOTAL"
}
], - "name": "string",
- "id": 0,
- "version": 0,
- "configuration": {
- "property1": {
- "value": "string",
- "methodType": "STATIC"
}, - "property2": {
- "value": "string",
- "methodType": "STATIC"
}
}, - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "createdDate": "2019-08-24T14:15:22Z"
}| X-COMPANY-ID required | string The company's unique ID |
| scoreReporting | string Value: "NUMBER" |
Array of objects (RiskThreshold) | |
| name | string |
| id | integer <int64> |
| version | integer <int32> |
object | |
| companyId | string <uuid> |
| archived | boolean |
| createdDate | string <date-time> |
{- "scoreReporting": "NUMBER",
- "riskThresholds": [
- {
- "isHidden": true,
- "id": 0,
- "weight": 0,
- "values": [
- {
- "value": 0,
- "id": 0,
- "indicator": "GOOD"
}
], - "metric": "LOW_FLOAT_RISK"
}
], - "name": "string",
- "id": 0,
- "version": 0,
- "configuration": {
- "property1": {
- "value": "string",
- "methodType": "STATIC"
}, - "property2": {
- "value": "string",
- "methodType": "STATIC"
}
}, - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "archived": true,
- "createdDate": "2019-08-24T14:15:22Z"
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| scoreReporting | string Enum: "Letter" "Color" "Number" |
Array of objects (QualityThreshold) | |
| name | string |
| id | integer <int64> |
| version | integer <int32> |
object | |
| companyId | string <uuid> |
| createdDate | string <date-time> |
{- "scoreReporting": "Letter",
- "qualityThreshold": [
- {
- "impactType": "MIXED",
- "fineImpact": 0,
- "badImpact": 0,
- "evaluationTarget": "PERCENTAGE",
- "isHidden": true,
- "id": 0,
- "values": [
- {
- "value": 0,
- "id": 0,
- "indicator": "GOOD"
}
], - "filters": [
- {
- "value": "string",
- "field": "string",
- "id": 0,
- "entity": "Activity",
- "operator": "EQUALS"
}
], - "metric": "ACTIVITIES_TOTAL"
}
], - "name": "string",
- "id": 0,
- "version": 0,
- "configuration": {
- "property1": {
- "value": "string",
- "methodType": "STATIC"
}, - "property2": {
- "value": "string",
- "methodType": "STATIC"
}
}, - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "createdDate": "2019-08-24T14:15:22Z"
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| name | string |
| id | string <uuid> |
| version | integer <int32> |
Array of objects (HealthProfileBucket) | |
| companyId | string <uuid> |
{- "name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "version": 0,
- "buckets": [
- {
- "weights": {
- "property1": 0,
- "property2": 0
}, - "percentComplete": 0
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda"
}| checklistId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (ChecklistSection) | |
| name | string |
| id | integer <int64> |
{- "sections": [
- {
- "name": "string",
- "id": 0,
- "sectionItems": [
- {
- "autoCheckConditions": "string",
- "autoCheckType": "ACTIVITY_FILTER",
- "id": 0,
- "description": "string",
- "displayOrder": 0
}
], - "displayOrder": 0
}
], - "name": "string",
- "id": 0
}| X-COMPANY-ID required | string The company's unique ID |
Array of objects (ChecklistSection) | |
| name | string |
| id | integer <int64> |
{- "sections": [
- {
- "name": "string",
- "id": 0,
- "sectionItems": [
- {
- "autoCheckConditions": "string",
- "autoCheckType": "ACTIVITY_FILTER",
- "id": 0,
- "description": "string",
- "displayOrder": 0
}
], - "displayOrder": 0
}
], - "name": "string",
- "id": 0
}| id required | string |
| X-COMPANY-ID required | string The company's unique ID |
object (Company) | |
object (CreateUserRequest) | |
Array of objects (ProjectPlanCreateRequest) |
{- "company": {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "location": {
- "streetAddress": "string",
- "city": "string",
- "provinceState": "string",
- "postalCode": "string",
- "country": "string"
}, - "logo": "string",
- "deleted": true,
- "companyType": "Foundations",
- "ssoRealm": "string",
- "maxUsers": 0,
- "maxSchedules": 0,
- "maxSchedulesPerProject": 0,
- "defaultProjectPlanId": "string",
- "slotUsageTypeId": "f10d6371-698b-45f1-bfc8-b30c868b93ea",
- "defaultQualityProfileId": 0,
- "defaultRiskProfileId": 0,
- "defaultHealthProfileId": "d07a9550-6071-4c7b-8165-92b21cdd7147",
- "isolatedAiTenant": true,
- "constructionIndustrySegment": "CONSULTANT",
- "aggregatedMetrics": true,
- "licenseType": "PROJECT_BASED",
- "academyAccess": true,
- "defaultWorkspaceTemplateId": "string",
- "defaultDashboardTemplateId": "string",
- "primaryChecklistId": 0
}, - "user": {
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "email": "user@example.com",
- "title": "string",
- "roleIds": [
- "string"
], - "ssoUser": true
}, - "projectPlans": [
- {
- "projectPlanId": "b7bff11d-5e89-43df-882f-7a587b49f0cf",
- "projectsAllocated": 0
}
]
}| X-COMPANY-ID required | string The company's unique ID |
object (Company) | |
object (CreateUserRequest) | |
Array of objects (ProjectPlanCreateRequest) |
{- "company": {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "location": {
- "streetAddress": "string",
- "city": "string",
- "provinceState": "string",
- "postalCode": "string",
- "country": "string"
}, - "logo": "string",
- "deleted": true,
- "companyType": "Foundations",
- "ssoRealm": "string",
- "maxUsers": 0,
- "maxSchedules": 0,
- "maxSchedulesPerProject": 0,
- "defaultProjectPlanId": "string",
- "slotUsageTypeId": "f10d6371-698b-45f1-bfc8-b30c868b93ea",
- "defaultQualityProfileId": 0,
- "defaultRiskProfileId": 0,
- "defaultHealthProfileId": "d07a9550-6071-4c7b-8165-92b21cdd7147",
- "isolatedAiTenant": true,
- "constructionIndustrySegment": "CONSULTANT",
- "aggregatedMetrics": true,
- "licenseType": "PROJECT_BASED",
- "academyAccess": true,
- "defaultWorkspaceTemplateId": "string",
- "defaultDashboardTemplateId": "string",
- "primaryChecklistId": 0
}, - "user": {
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "email": "user@example.com",
- "title": "string",
- "roleIds": [
- "string"
], - "ssoUser": true
}, - "projectPlans": [
- {
- "projectPlanId": "b7bff11d-5e89-43df-882f-7a587b49f0cf",
- "projectsAllocated": 0
}
]
}| X-COMPANY-ID required | string The company's unique ID |
| created | string <date-time> |
| lastUpdated | string <date-time> |
| version | integer <int32> |
| id | string <uuid> |
| name | string [ 0 .. 50 ] characters |
object (Location) | |
| logo | string [ 0 .. 50 ] characters |
| deleted | boolean |
| companyType | string Enum: "Foundations" "SmartPM" |
| ssoRealm | string |
| maxUsers | integer <int32> |
| maxSchedules | integer <int32> |
| maxSchedulesPerProject | integer <int32> |
| defaultProjectPlanId | string |
| slotUsageTypeId | string <uuid> |
| defaultQualityProfileId | integer <int64> |
| defaultRiskProfileId | integer <int64> |
| defaultHealthProfileId | string <uuid> |
| isolatedAiTenant | boolean |
| constructionIndustrySegment | string Enum: "CONSULTANT" "CONTRACTOR_OR_CM" "DEVELOPER" "GOVERNMENT_OR_MUNICIPALITY" "HOME_BUILDER" "INSURANCE" "INTERNAL" "OTHER" "OWNER" "RESELLER_OR_TECH_PARTNER" "SUBCONTRACTOR" "VENDOR_OR_SUPPLIER" "UNKNOWN" |
| aggregatedMetrics | boolean |
| licenseType | string Enum: "PROJECT_BASED" "USER_BASED" |
| academyAccess | boolean |
| defaultWorkspaceTemplateId | string |
| defaultDashboardTemplateId | string |
| primaryChecklistId | integer <int64> |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "location": {
- "streetAddress": "string",
- "city": "string",
- "provinceState": "string",
- "postalCode": "string",
- "country": "string"
}, - "logo": "string",
- "deleted": true,
- "companyType": "Foundations",
- "ssoRealm": "string",
- "maxUsers": 0,
- "maxSchedules": 0,
- "maxSchedulesPerProject": 0,
- "defaultProjectPlanId": "string",
- "slotUsageTypeId": "f10d6371-698b-45f1-bfc8-b30c868b93ea",
- "defaultQualityProfileId": 0,
- "defaultRiskProfileId": 0,
- "defaultHealthProfileId": "d07a9550-6071-4c7b-8165-92b21cdd7147",
- "isolatedAiTenant": true,
- "constructionIndustrySegment": "CONSULTANT",
- "aggregatedMetrics": true,
- "licenseType": "PROJECT_BASED",
- "academyAccess": true,
- "defaultWorkspaceTemplateId": "string",
- "defaultDashboardTemplateId": "string",
- "primaryChecklistId": 0
}{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "location": {
- "streetAddress": "string",
- "city": "string",
- "provinceState": "string",
- "postalCode": "string",
- "country": "string"
}, - "logo": "string",
- "deleted": true,
- "companyType": "Foundations",
- "ssoRealm": "string",
- "maxUsers": 0,
- "maxSchedules": 0,
- "maxSchedulesPerProject": 0,
- "defaultProjectPlanId": "string",
- "slotUsageTypeId": "f10d6371-698b-45f1-bfc8-b30c868b93ea",
- "defaultQualityProfileId": 0,
- "defaultRiskProfileId": 0,
- "defaultHealthProfileId": "d07a9550-6071-4c7b-8165-92b21cdd7147",
- "isolatedAiTenant": true,
- "constructionIndustrySegment": "CONSULTANT",
- "aggregatedMetrics": true,
- "licenseType": "PROJECT_BASED",
- "academyAccess": true,
- "defaultWorkspaceTemplateId": "string",
- "defaultDashboardTemplateId": "string",
- "primaryChecklistId": 0
}| X-COMPANY-ID required | string The company's unique ID |
| created | string <date-time> |
| lastUpdated | string <date-time> |
| version | integer <int32> |
| id | string <uuid> |
| name | string [ 0 .. 50 ] characters |
object (Location) | |
| logo | string [ 0 .. 50 ] characters |
| deleted | boolean |
| companyType | string Enum: "Foundations" "SmartPM" |
| ssoRealm | string |
| maxUsers | integer <int32> |
| maxSchedules | integer <int32> |
| maxSchedulesPerProject | integer <int32> |
| defaultProjectPlanId | string |
| slotUsageTypeId | string <uuid> |
| defaultQualityProfileId | integer <int64> |
| defaultRiskProfileId | integer <int64> |
| defaultHealthProfileId | string <uuid> |
| isolatedAiTenant | boolean |
| constructionIndustrySegment | string Enum: "CONSULTANT" "CONTRACTOR_OR_CM" "DEVELOPER" "GOVERNMENT_OR_MUNICIPALITY" "HOME_BUILDER" "INSURANCE" "INTERNAL" "OTHER" "OWNER" "RESELLER_OR_TECH_PARTNER" "SUBCONTRACTOR" "VENDOR_OR_SUPPLIER" "UNKNOWN" |
| aggregatedMetrics | boolean |
| licenseType | string Enum: "PROJECT_BASED" "USER_BASED" |
| academyAccess | boolean |
| defaultWorkspaceTemplateId | string |
| defaultDashboardTemplateId | string |
| primaryChecklistId | integer <int64> |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "location": {
- "streetAddress": "string",
- "city": "string",
- "provinceState": "string",
- "postalCode": "string",
- "country": "string"
}, - "logo": "string",
- "deleted": true,
- "companyType": "Foundations",
- "ssoRealm": "string",
- "maxUsers": 0,
- "maxSchedules": 0,
- "maxSchedulesPerProject": 0,
- "defaultProjectPlanId": "string",
- "slotUsageTypeId": "f10d6371-698b-45f1-bfc8-b30c868b93ea",
- "defaultQualityProfileId": 0,
- "defaultRiskProfileId": 0,
- "defaultHealthProfileId": "d07a9550-6071-4c7b-8165-92b21cdd7147",
- "isolatedAiTenant": true,
- "constructionIndustrySegment": "CONSULTANT",
- "aggregatedMetrics": true,
- "licenseType": "PROJECT_BASED",
- "academyAccess": true,
- "defaultWorkspaceTemplateId": "string",
- "defaultDashboardTemplateId": "string",
- "primaryChecklistId": 0
}| id required | string |
| X-COMPANY-ID required | string The company's unique ID |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "location": {
- "streetAddress": "string",
- "city": "string",
- "provinceState": "string",
- "postalCode": "string",
- "country": "string"
}, - "logo": "string",
- "deleted": true,
- "companyType": "Foundations",
- "ssoRealm": "string",
- "maxUsers": 0,
- "maxSchedules": 0,
- "maxSchedulesPerProject": 0,
- "defaultProjectPlanId": "string",
- "slotUsageTypeId": "f10d6371-698b-45f1-bfc8-b30c868b93ea",
- "defaultQualityProfileId": 0,
- "defaultRiskProfileId": 0,
- "defaultHealthProfileId": "d07a9550-6071-4c7b-8165-92b21cdd7147",
- "isolatedAiTenant": true,
- "constructionIndustrySegment": "CONSULTANT",
- "aggregatedMetrics": true,
- "licenseType": "PROJECT_BASED",
- "academyAccess": true,
- "defaultWorkspaceTemplateId": "string",
- "defaultDashboardTemplateId": "string",
- "primaryChecklistId": 0
}| X-COMPANY-ID required | string The company's unique ID |
{- "entities": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}
]
}| companyId required | string <uuid> |
| roleId required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string |
| description | string [ 0 .. 255 ] characters |
| type | string Enum: "Company" "Project" "Site" |
| permissions required | Array of strings unique |
| defaultProjectRoleId | string <uuid> |
{- "name": "string",
- "description": "string",
- "type": "Company",
- "permissions": [
- "string"
], - "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499"
}| companyId required | string <uuid> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string |
| description | string [ 0 .. 255 ] characters |
| type | string Enum: "Company" "Project" "Site" |
| permissions required | Array of strings unique |
| defaultProjectRoleId | string <uuid> |
{- "name": "string",
- "description": "string",
- "type": "Company",
- "permissions": [
- "string"
], - "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499"
}| X-COMPANY-ID required | string The company's unique ID |
required | object (ForemanMessageRequest) |
| agentType required | string Enum: "FULL" "KB" |
| subject | string [ 0 .. 255 ] characters |
| scenarioId | integer <int64> |
| modelId | integer <int64> |
| projectId | integer <int64> |
| chatSessionId | string <uuid> |
| archived | boolean |
{- "foremanMessage": {
- "message": "string",
- "actor": "USER"
}, - "agentType": "FULL",
- "subject": "string",
- "scenarioId": 0,
- "modelId": 0,
- "projectId": 0,
- "chatSessionId": "5bc255f8-717c-428e-a713-c403f4dfdc02",
- "archived": true
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (ProjectFileImportRequest) | |
| sendNotification | boolean |
{- "files": [
- {
- "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608",
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "name": "string",
- "dataDate": "2019-08-24T14:15:22Z",
- "contractualEndDate": "2019-08-24T14:15:22Z",
- "skipSubsetValidations": true,
- "importLogHitRateGoal": 0
}
], - "sendNotification": true
}| sortBy | Array of strings Default: ["PROJECT.NAME:ASC"] |
| columns | Array of strings |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| columns | Array of strings |
| dataDate | string <date-time> |
{- "columns": [
- "string"
], - "dataDate": "2019-08-24T14:15:22Z"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| columns | Array of strings |
| dataDate | string <date-time> |
{- "columns": [
- "string"
], - "dataDate": "2019-08-24T14:15:22Z"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| modelId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| columns | Array of strings |
| dataDate | string <date-time> |
{- "columns": [
- "string"
], - "dataDate": "2019-08-24T14:15:22Z"
}| X-COMPANY-ID required | string The company's unique ID |
| columns | Array of strings |
Array of objects (ScenarioReference) |
{- "columns": [
- "string"
], - "scenarios": [
- {
- "projectId": 0,
- "scenarioId": 0,
- "modelId": 0
}
]
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| qualityChart | boolean |
| healthChart | boolean |
| compressionChart | boolean |
| spiChart | boolean |
| hitRateChart | boolean |
| missingLogicChart | boolean |
| totalFloatChart | boolean |
| highFloatChart | boolean |
| criticalPathChart | boolean |
| startFinishChart | boolean |
object | |
object | |
object | |
object | |
object |
{- "qualityChart": true,
- "healthChart": true,
- "compressionChart": true,
- "spiChart": true,
- "hitRateChart": true,
- "missingLogicChart": true,
- "totalFloatChart": true,
- "highFloatChart": true,
- "criticalPathChart": true,
- "startFinishChart": true,
- "progressChart": {
- "property1": true,
- "property2": true
}, - "changesChart": {
- "property1": true,
- "property2": true
}, - "delayChart": {
- "property1": true,
- "property2": true
}, - "startAccuracyChart": {
- "property1": true,
- "property2": true
}, - "finishAccuracyChart": {
- "property1": true,
- "property2": true
}
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| startDate | string <date-time> |
| finishDate | string <date-time> |
| filterId | Array of integers <int64> |
| ganttStructure | string Enum: "WBS" "ACTIVITY_CODE" "NONE" |
| groupByCollapsedIds | Array of strings |
| groupByActivityCodeTypeIds | Array of integers <int64> |
| sortColumn | string Enum: "ACTIVITYID" "NAME" "STARTINGSTARTDATE" "STARTINGFINISHDATE" "STARTINGPERCENTCOMPLETE" "STARTINGTOTALFLOAT" "ENDINGSTARTDATE" "ENDINGFINISHDATE" "ENDINGPERCENTCOMPLETE" "ENDINGTOTALFLOAT" "VARIANCESTARTDATE" "VARIANCEFINISHDATE" "VARIANCEPERCENTCOMPLETE" "VARIANCETOTALFLOAT" |
| sortDirection | string Enum: "ASC" "DESC" |
| filterWindow | boolean |
| filter | Array of strings Items Enum: "STARTED_ON_TIME" "STARTED_LATE" "DID_NOT_START" "FINISHED_ON_TIME" "FINISHED_LATE" "DID_NOT_FINISH" "SHOULD_HAVE_STARTED" "SHOULD_HAVE_FINISHED" |
{- "startDate": "2019-08-24T14:15:22Z",
- "finishDate": "2019-08-24T14:15:22Z",
- "filterId": [
- 0
], - "ganttStructure": "WBS",
- "groupByCollapsedIds": [
- "string"
], - "groupByActivityCodeTypeIds": [
- 0
], - "sortColumn": "ACTIVITYID",
- "sortDirection": "ASC",
- "filterWindow": true,
- "filter": [
- "STARTED_ON_TIME"
]
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| periodMonthDate | string |
| ganttStructure | string Enum: "WBS" "ACTIVITY_CODE" "NONE" |
| filterId | Array of integers <int64> |
| sortBy | string Enum: "ID" "NAME" "BASELINESTARTDATE" "BASELINEFINISHDATE" "BASELINEPERCENTCOMPLETE" "BASELINETOTALFLOAT" "BASELINEDURATION" "CURRENTSTARTDATE" "CURRENTFINISHDATE" "CURRENTPERCENTCOMPLETE" "CURRENTTOTALFLOAT" "CURRENTDURATION" "VARIANCESTARTDATE" "VARIANCEFINISHDATE" "VARIANCEPERCENTCOMPLETE" "VARIANCETOTALFLOAT" "VARIANCEDURATION" |
| sortDirection | string Enum: "ASC" "DESC" |
| activityCodeTypes | Array of integers <int64> |
| collapsedIds | Array of strings |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| startDate required | string |
| finishDate required | string |
| ganttStructure | string Enum: "WBS" "ACTIVITY_CODE" "NONE" |
| filterId | Array of integers <int64> |
| sortBy | string Enum: "ACTIVITYID" "NAME" "STARTINGSTARTDATE" "STARTINGFINISHDATE" "STARTINGPERCENTCOMPLETE" "STARTINGTOTALFLOAT" "ENDINGSTARTDATE" "ENDINGFINISHDATE" "ENDINGPERCENTCOMPLETE" "ENDINGTOTALFLOAT" "VARIANCESTARTDATE" "VARIANCEFINISHDATE" "VARIANCEPERCENTCOMPLETE" "VARIANCETOTALFLOAT" |
| sortDirection | string Enum: "ASC" "DESC" |
| activityCodeTypes | Array of integers <int64> |
| collapsedIds | Array of strings |
| filterWindow | boolean |
| filter | Array of strings Items Enum: "STARTED_ON_TIME" "STARTED_LATE" "DID_NOT_START" "FINISHED_ON_TIME" "FINISHED_LATE" "DID_NOT_FINISH" "SHOULD_HAVE_STARTED" "SHOULD_HAVE_FINISHED" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| reportId required | integer <int32> |
| X-COMPANY-ID required | string The company's unique ID |
| to | string |
| subject | string |
| comment | string |
| type | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
{- "to": "string",
- "subject": "string",
- "comment": "string",
- "type": "CHANGES"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| reportId required | integer <int32> |
| isAttachment required | boolean |
| reportType required | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
| fileName | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| periodFrom | string <date> |
| periodTo | string <date> |
| dataDate | string <date-time> |
| planned | boolean |
| filterId | Array of integers <int64> |
| ganttStructure | string Enum: "WBS" "ACTIVITY_CODE" "NONE" |
| searchTerm | string |
| groupByCollapsedIds | Array of strings |
| groupByActivityCodeTypeIds | Array of integers <int64> |
| sortByColumn | string Enum: "ACTIVITY_ID" "ACTIVITY_NAME" "ACTUAL_DURATION" "BLENDED_START_DATE" "BLENDED_END_DATE" "ACTUAL_START_DATE" "ACTUAL_END_DATE" "LATE_START_DATE" "LATE_END_DATE" "PERCENT_COMPLETE" "DURATION_PERCENT_COMPLETE" "PHYSICAL_PERCENT_COMPLETE" "DURATION_VARIANCE" "UNITS_PERCENT_COMPLETE" "TOTAL_FLOAT" "FREE_FLOAT" "PLANNED_START_DATE" "PLANNED_END_DATE" "PLANNED_DURATION" "DURATION" "REMAINING_DURATION" "START_DATE" "END_DATE" "NATIVE_FLOAT_TOTAL" "IN_LONGEST_PATH" "SOURCE_START_DATE" "SOURCE_END_DATE" "ROLLED_BACK_REMAINING_DURATION" "SOURCE_ACTUAL_START_DATE" "SOURCE_ACTUAL_END_DATE" "BASELINE_START_DATE" "BASELINE_END_DATE" "BASELINE_DURATION" "PLANNED_BUDGET" "PLANNED_MANPOWER" "BASELINE_FLOAT" "BASELINE_NATIVE_FLOAT" "FLOAT_VARIANCE" |
| sortDirection | string Enum: "ASC" "DESC" |
Array of objects (GanttChartColumnDefinition) | |
| timelineScale | string Enum: "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" |
| additionalActivityIds | Array of integers <int64> |
| includeDeleted | boolean |
{- "paperSize": "Letter_Portrait",
- "periodFrom": "2019-08-24",
- "periodTo": "2019-08-24",
- "dataDate": "2019-08-24T14:15:22Z",
- "planned": true,
- "filterId": [
- 0
], - "ganttStructure": "WBS",
- "searchTerm": "string",
- "groupByCollapsedIds": [
- "string"
], - "groupByActivityCodeTypeIds": [
- 0
], - "sortByColumn": "ACTIVITY_ID",
- "sortDirection": "ASC",
- "columns": [
- {
- "column": "ACTIVITY_ID",
- "columnWidth": 0
}
], - "timelineScale": "DAILY",
- "additionalActivityIds": [
- 0
], - "includeDeleted": true
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (GanttChartColumnDefinition) | |
| searchTerm | string |
| filterId | Array of integers <int64> |
| dataDate | string <date-time> |
| timelineScale | string Enum: "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" |
| additionalActivityIds | Array of integers <int64> |
| includeDeleted | boolean |
{- "columns": [
- {
- "column": "ACTIVITY_ID",
- "columnWidth": 0
}
], - "searchTerm": "string",
- "filterId": [
- 0
], - "dataDate": "2019-08-24T14:15:22Z",
- "timelineScale": "DAILY",
- "additionalActivityIds": [
- 0
], - "includeDeleted": true
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| columns required | Array of strings Items Enum: "ACTIVITY_ID" "ACTIVITY_NAME" "ACTUAL_DURATION" "BLENDED_START_DATE" "BLENDED_END_DATE" "ACTUAL_START_DATE" "ACTUAL_END_DATE" "LATE_START_DATE" "LATE_END_DATE" "PERCENT_COMPLETE" "DURATION_PERCENT_COMPLETE" "PHYSICAL_PERCENT_COMPLETE" "DURATION_VARIANCE" "UNITS_PERCENT_COMPLETE" "TOTAL_FLOAT" "FREE_FLOAT" "PLANNED_START_DATE" "PLANNED_END_DATE" "PLANNED_DURATION" "DURATION" "REMAINING_DURATION" "START_DATE" "END_DATE" "NATIVE_FLOAT_TOTAL" "IN_LONGEST_PATH" "SOURCE_START_DATE" "SOURCE_END_DATE" "ROLLED_BACK_REMAINING_DURATION" "SOURCE_ACTUAL_START_DATE" "SOURCE_ACTUAL_END_DATE" "BASELINE_START_DATE" "BASELINE_END_DATE" "BASELINE_DURATION" "PLANNED_BUDGET" "PLANNED_MANPOWER" "BASELINE_FLOAT" "BASELINE_NATIVE_FLOAT" "FLOAT_VARIANCE" |
| ganttStructure required | string Enum: "WBS" "ACTIVITY_CODE" "NONE" |
| dataDate required | string |
| sortBy required | string Enum: "ACTIVITY_ID" "ACTIVITY_NAME" "ACTUAL_DURATION" "BLENDED_START_DATE" "BLENDED_END_DATE" "ACTUAL_START_DATE" "ACTUAL_END_DATE" "LATE_START_DATE" "LATE_END_DATE" "PERCENT_COMPLETE" "DURATION_PERCENT_COMPLETE" "PHYSICAL_PERCENT_COMPLETE" "DURATION_VARIANCE" "UNITS_PERCENT_COMPLETE" "TOTAL_FLOAT" "FREE_FLOAT" "PLANNED_START_DATE" "PLANNED_END_DATE" "PLANNED_DURATION" "DURATION" "REMAINING_DURATION" "START_DATE" "END_DATE" "NATIVE_FLOAT_TOTAL" "IN_LONGEST_PATH" "SOURCE_START_DATE" "SOURCE_END_DATE" "ROLLED_BACK_REMAINING_DURATION" "SOURCE_ACTUAL_START_DATE" "SOURCE_ACTUAL_END_DATE" "BASELINE_START_DATE" "BASELINE_END_DATE" "BASELINE_DURATION" "PLANNED_BUDGET" "PLANNED_MANPOWER" "BASELINE_FLOAT" "BASELINE_NATIVE_FLOAT" "FLOAT_VARIANCE" |
| SD required | string Enum: "ASC" "DESC" |
| ACTS | Array of integers <int64> |
| CIDS | Array of strings |
| filterId | Array of integers <int64> |
| ST | string |
| additionalActivityIds | Array of integers <int64> |
| includeDeleted | boolean |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| columns required | Array of strings Items Enum: "ACTIVITY_ID" "ACTIVITY_NAME" "ACTUAL_DURATION" "BLENDED_START_DATE" "BLENDED_END_DATE" "ACTUAL_START_DATE" "ACTUAL_END_DATE" "LATE_START_DATE" "LATE_END_DATE" "PERCENT_COMPLETE" "DURATION_PERCENT_COMPLETE" "PHYSICAL_PERCENT_COMPLETE" "DURATION_VARIANCE" "UNITS_PERCENT_COMPLETE" "TOTAL_FLOAT" "FREE_FLOAT" "PLANNED_START_DATE" "PLANNED_END_DATE" "PLANNED_DURATION" "DURATION" "REMAINING_DURATION" "START_DATE" "END_DATE" "NATIVE_FLOAT_TOTAL" "IN_LONGEST_PATH" "SOURCE_START_DATE" "SOURCE_END_DATE" "ROLLED_BACK_REMAINING_DURATION" "SOURCE_ACTUAL_START_DATE" "SOURCE_ACTUAL_END_DATE" "BASELINE_START_DATE" "BASELINE_END_DATE" "BASELINE_DURATION" "PLANNED_BUDGET" "PLANNED_MANPOWER" "BASELINE_FLOAT" "BASELINE_NATIVE_FLOAT" "FLOAT_VARIANCE" |
| ganttStructure required | string Enum: "WBS" "ACTIVITY_CODE" "NONE" |
| dataDate required | string |
| sortBy required | string Enum: "ACTIVITY_ID" "ACTIVITY_NAME" "ACTUAL_DURATION" "BLENDED_START_DATE" "BLENDED_END_DATE" "ACTUAL_START_DATE" "ACTUAL_END_DATE" "LATE_START_DATE" "LATE_END_DATE" "PERCENT_COMPLETE" "DURATION_PERCENT_COMPLETE" "PHYSICAL_PERCENT_COMPLETE" "DURATION_VARIANCE" "UNITS_PERCENT_COMPLETE" "TOTAL_FLOAT" "FREE_FLOAT" "PLANNED_START_DATE" "PLANNED_END_DATE" "PLANNED_DURATION" "DURATION" "REMAINING_DURATION" "START_DATE" "END_DATE" "NATIVE_FLOAT_TOTAL" "IN_LONGEST_PATH" "SOURCE_START_DATE" "SOURCE_END_DATE" "ROLLED_BACK_REMAINING_DURATION" "SOURCE_ACTUAL_START_DATE" "SOURCE_ACTUAL_END_DATE" "BASELINE_START_DATE" "BASELINE_END_DATE" "BASELINE_DURATION" "PLANNED_BUDGET" "PLANNED_MANPOWER" "BASELINE_FLOAT" "BASELINE_NATIVE_FLOAT" "FLOAT_VARIANCE" |
| SD required | string Enum: "ASC" "DESC" |
| ACTS | Array of integers <int64> |
| CIDS | Array of strings |
| filterId | Array of integers <int64> |
| ST | string |
| additionalActivityIds | Array of integers <int64> |
| includeDeleted | boolean |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| groupBy | string Enum: "NONE" "ACTIVITY_CODE_TYPE" "WBS" |
| activityCodeTypeIds | Array of integers <int64> |
| columns | Array of strings Items Enum: "ID" "NAME" "START_DATE" "END_DATE" "DURATION" "TOTAL_FLOAT" "CURRENT_FORECAST_FINISH" "FINISH_VARIANCE" "SUCCESSORS" |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string <date-time> |
{- "groupBy": "NONE",
- "activityCodeTypeIds": [
- 0
], - "columns": [
- "ID"
], - "filterId": [
- 0
], - "activityCodeFilter": [
- 0
], - "dataDate": "2019-08-24T14:15:22Z"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| groupBy | string Enum: "NONE" "ACTIVITY_CODE_TYPE" "WBS" |
| activityCodeTypeIds | Array of integers <int64> |
| columns | Array of strings Items Enum: "START_DATE" "END_DATE" "DURATION" "TOTAL_FLOAT" "CURRENT_FORECAST_FINISH" "START_VARIANCE" "FINISH_VARIANCE" "RISK_INDEX" "DURATION_VARIANCE" "DURATION_VARIANCE_PERCENT" "SUCCESSORS" "PREDECESSORS" "SPI" "PLANNED_VS_ACTUAL" "INTERCONNECTIONS" "REMAINING_ACTIVITIES" |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string <date-time> |
{- "groupBy": "NONE",
- "activityCodeTypeIds": [
- 0
], - "columns": [
- "START_DATE"
], - "filterId": [
- 0
], - "activityCodeFilter": [
- 0
], - "dataDate": "2019-08-24T14:15:22Z"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| weatherStationId | string |
{- "weatherStationId": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| stationId | string |
| duration | integer <int32> |
| lowTemperature | integer <int32> |
| highTemperature | integer <int32> |
| precipitation | number <double> |
| snow | number <double> |
| wind | integer <int32> |
| comments | string |
{- "stationId": "string",
- "duration": 0,
- "lowTemperature": 0,
- "highTemperature": 0,
- "precipitation": 0,
- "snow": 0,
- "wind": 0,
- "comments": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectPlanId | string |
{- "projectPlanId": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| status | string Enum: "ACTIVE" "INACTIVE" "COMPLETE" |
{- "status": "ACTIVE"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string |
| description | string |
| scheduleIds required | Array of integers <int64> |
| ruleIds required | Array of integers <int64> |
| requester | string |
| scenarioType | string Enum: "COMPLETE" "PARTIAL" |
| activityId | integer <int64> |
| autoUpdate | boolean |
object | |
| modelId | integer <int64> |
object | |
| requesterCompanyName | string |
| aiTenantId | string |
{- "name": "string",
- "description": "string",
- "scheduleIds": [
- 0
], - "ruleIds": [
- 0
], - "requester": "string",
- "scenarioType": "COMPLETE",
- "activityId": 0,
- "autoUpdate": true,
- "scenarioConfiguration": {
- "property1": "string",
- "property2": "string"
}, - "modelId": 0,
- "contractualEndDates": {
- "property1": "2019-08-24T14:15:22Z",
- "property2": "2019-08-24T14:15:22Z"
}, - "requesterCompanyName": "string",
- "aiTenantId": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| riskProfileId | integer <int64> |
{- "riskProfileId": 0
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| qualityProfileId | integer <int64> |
{- "qualityProfileId": 0
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| dataDate | string <date-time> |
| contractualEndDate | string <date-time> |
{- "dataDate": "2019-08-24T14:15:22Z",
- "contractualEndDate": "2019-08-24T14:15:22Z"
}| projectId required | integer <int64> |
| activityId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| dataDate | string <date-time> |
| contractualEndDate | string <date-time> |
{- "dataDate": "2019-08-24T14:15:22Z",
- "contractualEndDate": "2019-08-24T14:15:22Z"
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
| isAnd | boolean |
| type | string Enum: "Company" "CustomReport" "Delay" "Manual" "Rule" "Temporary" |
Array of objects (QueryAddRequest) | |
Array of objects (FilterCreateRequest) | |
Array of objects (FilterCreateRequest) |
{- "name": "string",
- "isAnd": true,
- "type": "Company",
- "queries": [
- {
- "attribute": 0,
- "operator": 0,
- "value": "string",
- "hvalue": "string"
}
], - "subFilters": [
- { }
], - "filters": [
- { }
]
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogId | integer <int64> |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| companyLogo | string |
object (WBSTreeLevel) |
{- "importLogId": 0,
- "paperSize": "Letter_Portrait",
- "companyLogo": "string",
- "wbsTreeLevel": {
- "to": 0,
- "from": 0
}
}0| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| importLogId | integer <int64> |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| companyLogo | string |
| activityTypeCodes | Array of integers <int64> |
| activityCodeLabel | string Enum: "Value" "Description" |
{- "importLogId": 0,
- "paperSize": "Letter_Portrait",
- "companyLogo": "string",
- "activityTypeCodes": [
- 0
], - "activityCodeLabel": "Value"
}0| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| dataDate | string |
| columns | Array of strings Items Enum: "AUDIT_DATE" "FRIENDLY_ID" "WBS_NAME" "TRADE" "PREDECESSOR" "SUCCESSOR" "CHANGE_ITEM" "OLD_VALUE" "NEW_VALUE" |
| sortColumn | string Enum: "AUDIT_DATE" "FRIENDLY_ID" "WBS_NAME" "TRADE" "PREDECESSOR" "SUCCESSOR" "CHANGE_ITEM" "OLD_VALUE" "NEW_VALUE" |
| sortDirection | string Enum: "ASC" "DESC" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (AuditLogSheetExportRequest) |
{- "sheets": [
- {
- "metric": "string",
- "columns": [
- "AUDIT_DATE"
], - "sortColumn": "AUDIT_DATE",
- "sortDirection": "ASC"
}
]
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| metric required | string Enum: "CriticalChanges" "NearCriticalChanges" "ActivityChanges" "ActivitiesAdded" "ActivitiesDeleted" "LogicChanges" "DurationChanges" "DelayedActivityChanges" "AllCalendarChanges" "CalendarChanges" "WorkingDayChanges" "FlaggedChanges" |
| dataDate | string |
| columns | Array of strings Items Enum: "AUDIT_DATE" "FRIENDLY_ID" "WBS_NAME" "TRADE" "PREDECESSOR" "SUCCESSOR" "CHANGE_ITEM" "OLD_VALUE" "NEW_VALUE" |
| sortColumn | string Enum: "AUDIT_DATE" "FRIENDLY_ID" "WBS_NAME" "TRADE" "PREDECESSOR" "SUCCESSOR" "CHANGE_ITEM" "OLD_VALUE" "NEW_VALUE" |
| sortDirection | string Enum: "ASC" "DESC" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| reportType | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
| printTimeout | integer <int64> Default: 60000 |
| X-COMPANY-ID required | string The company's unique ID |
| reportRoute | string |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| landScape | boolean |
| companyLogo | string |
| reportTitle | string |
| pageTimeout | number <double> |
object | |
object | |
| pageWidth | number <double> |
| pageHeight | number <double> |
{- "reportRoute": "string",
- "paperSize": "Letter_Portrait",
- "landScape": true,
- "companyLogo": "string",
- "reportTitle": "string",
- "pageTimeout": 0,
- "leftHeaderTemplateParams": {
- "property1": "string",
- "property2": "string"
}, - "rightHeaderTemplateParams": {
- "property1": "string",
- "property2": "string"
}, - "pageWidth": 0,
- "pageHeight": 0
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| entity | string Enum: "Activity" "Logic" "Report" "Calendar" "CalendarWorktime" "WBS" |
| entityId | integer <int64> |
| auditDate | string <date> |
| field | string |
{- "entity": "Activity",
- "entityId": 0,
- "auditDate": "2019-08-24",
- "field": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (AuditLogFlagRequest) |
{- "auditLogFlagRequests": [
- {
- "entity": "Activity",
- "entityId": 0,
- "auditDate": "2019-08-24",
- "field": "string"
}
]
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Array of objects (AuditLogFlagDeleteRequest) | |
Array of objects (AuditLogFlagDeleteRequest) |
{- "auditLogFlagDeleteRequests": [
- {
- "auditLogFlagId": 0
}
], - "auditLogFlagRequests": [
- {
- "auditLogFlagId": 0
}
]
}| X-COMPANY-ID required | string The company's unique ID |
| reportRoute | string |
| paperSize | string Enum: "Letter_Portrait" "Letter" "Legal" "Tabloid" "ArchD" "ArchE" |
| landScape | boolean |
| companyLogo | string |
| reportTitle | string |
| pageTimeout | number <double> |
object | |
object | |
| pageWidth | number <double> |
| pageHeight | number <double> |
{- "reportRoute": "string",
- "paperSize": "Letter_Portrait",
- "landScape": true,
- "companyLogo": "string",
- "reportTitle": "string",
- "pageTimeout": 0,
- "leftHeaderTemplateParams": {
- "property1": "string",
- "property2": "string"
}, - "rightHeaderTemplateParams": {
- "property1": "string",
- "property2": "string"
}, - "pageWidth": 0,
- "pageHeight": 0
}| X-COMPANY-ID required | string The company's unique ID |
| microservices | Array of strings Items Enum: "AI_API" "EMAIL" "DELAY_ANALYSIS" "IMPORT" "PERCENT_COMPLETE" "WEATHER" |
{- "microservices": [
- "AI_API"
]
}| X-COMPANY-ID required | string The company's unique ID |
| microservices | Array of strings Items Enum: "AI_API" "EMAIL" "DELAY_ANALYSIS" "IMPORT" "PERCENT_COMPLETE" "WEATHER" |
{- "microservices": [
- "AI_API"
]
}| projectId required | integer <int64> |
| dataType required | string Enum: "RFI" "SUBMITTAL" "FILE" "USER" |
| provider required | string Enum: "AUTODESK" "PROCORE" "EGNYTE" "OPC" |
| X-COMPANY-ID required | string The company's unique ID |
| X-COMPANY-ID required | string The company's unique ID |
| username | string |
| password | string |
| domain | string |
| providerName | string Enum: "AUTODESK" "PROCORE" "EGNYTE" "OPC" |
{- "username": "string",
- "password": "string",
- "domain": "string",
- "providerName": "AUTODESK"
}| X-COMPANY-ID required | string The company's unique ID |
| token required | string |
| email required | string |
| password required | string |
| passwordVerify required | string |
{- "token": "string",
- "email": "string",
- "password": "string",
- "passwordVerify": "string"
}| X-COMPANY-ID required | string The company's unique ID |
| ticketName | string |
| ticketDescription | string |
| companyName | string |
| projectName | string |
| scenarioName | string |
| chatSessionId | string <uuid> |
| traceId | string <uuid> |
{- "ticketName": "string",
- "ticketDescription": "string",
- "companyName": "string",
- "projectName": "string",
- "scenarioName": "string",
- "chatSessionId": "5bc255f8-717c-428e-a713-c403f4dfdc02",
- "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa"
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| fileId | string <uuid> |
| companyId | string |
| source | string Enum: "SmartPM" "XER" "MPP" "Excel" "PMXML" "PPX" "PP" |
| dataDate | string <date-time> |
| skipSubsetValidations | boolean |
| projectPlanId | string |
| skipProjectLimit | boolean |
{- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "companyId": "string",
- "source": "SmartPM",
- "dataDate": "2019-08-24T14:15:22Z",
- "skipSubsetValidations": true,
- "projectPlanId": "string",
- "skipProjectLimit": true
}{- "valid": true,
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "message": "string",
- "errorCode": "string"
}| companyId required | string |
| files required | Array of strings <binary> |
| source required | string |
| X-COMPANY-ID required | string The company's unique ID |
{- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "filePath": "string",
- "message": "string"
}| companyId required | string |
| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| fileId | string <uuid> |
| companyId | string |
| source | string Enum: "SmartPM" "XER" "MPP" "Excel" "PMXML" "PPX" "PP" |
| dataDate | string <date-time> |
| skipSubsetValidations | boolean |
| projectPlanId | string |
| skipProjectLimit | boolean |
{- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "companyId": "string",
- "source": "SmartPM",
- "dataDate": "2019-08-24T14:15:22Z",
- "skipSubsetValidations": true,
- "projectPlanId": "string",
- "skipProjectLimit": true
}{- "valid": true,
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "message": "string",
- "errorCode": "string"
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| fileId | string <uuid> |
| companyId | string |
| source | string Enum: "SmartPM" "XER" "MPP" "Excel" "PMXML" "PPX" "PP" |
{- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "companyId": "string",
- "source": "SmartPM"
}{- "dataDate": "2019-08-24T14:15:22Z",
- "activityCount": 0,
- "mustFinishDate": "2019-08-24T14:15:22Z"
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| importId | string <uuid> |
| projectId | integer <int64> |
| scenarioId | integer <int64> |
| originalProjectId | integer <int64> |
| file | string |
| originalFileName | string |
| fileId | string <uuid> |
| name | string |
| city | string |
| state | string |
| zipCode | string |
| country | string |
| latitude | number |
| longitude | number |
| skipBaseline | boolean |
| underConstruction | boolean |
| userId | string |
| companyId | string |
| jwt | string |
| imagePath | string |
| requester | string |
| planId | string |
| qualityProfileId | integer <int64> |
| riskProfileId | integer <int64> |
| importLogHitRateGoal | integer <int32> |
Array of objects (ImportException) | |
Array of objects (ProjectUserRoleMapping) | |
Array of objects (ProjectUserGroupRoleMapping) | |
object | |
object | |
object | |
object | |
| archived | boolean |
| aiTenantId | string |
| contractualEndDate | string <date-time> |
| projectStatus | string Enum: "ACTIVE" "INACTIVE" "COMPLETE" |
| skipExternalEmail | boolean |
| skipProjectLevelItems | boolean |
| skipDelayAnalysis | boolean |
| skipClassifySchedule | boolean |
| skipImportLogChecklistStep | boolean |
| skipSubsetValidations | boolean |
| skipProjectMetadataValidation | boolean |
| skipAllValidations | boolean |
| useProvidedContractualEndDates | boolean |
| source | string Enum: "SmartPM" "XER" "MPP" "Excel" "PMXML" "PPX" "PP" |
| dataDate | string <date-time> |
| projectCreationType | string Enum: "MANUAL" "QUALITY_CHECK" "SCHEDULE_COMPARISON" "SCHEDULE_REVIEW" |
{- "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608",
- "projectId": 0,
- "scenarioId": 0,
- "originalProjectId": 0,
- "file": "string",
- "originalFileName": "string",
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "name": "string",
- "city": "string",
- "state": "string",
- "zipCode": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "skipBaseline": true,
- "underConstruction": true,
- "userId": "string",
- "companyId": "string",
- "jwt": "string",
- "imagePath": "string",
- "requester": "string",
- "planId": "string",
- "qualityProfileId": 0,
- "riskProfileId": 0,
- "importLogHitRateGoal": 0,
- "importExceptions": [
- {
- "entity": "Activity",
- "action": "ADDED",
- "entityId": "string",
- "importExceptionField": "actualManpower",
- "importExceptionValue": "string"
}
], - "projectUserRoleMappings": [
- {
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
- "provisionedSource": "SMARTPM"
}
], - "projectUserGroupRoleMappings": [
- {
- "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
- "userGroupId": "080a16e0-8946-456c-aef9-504a239bc5ab"
}
], - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "projectConfiguration": {
- "property1": "string",
- "property2": "string"
}, - "scenarioConfiguration": {
- "property1": "string",
- "property2": "string"
}, - "modelConfiguration": {
- "property1": "string",
- "property2": "string"
}, - "archived": true,
- "aiTenantId": "string",
- "contractualEndDate": "2019-08-24T14:15:22Z",
- "projectStatus": "ACTIVE",
- "skipExternalEmail": true,
- "skipProjectLevelItems": true,
- "skipDelayAnalysis": true,
- "skipClassifySchedule": true,
- "skipImportLogChecklistStep": true,
- "skipSubsetValidations": true,
- "skipProjectMetadataValidation": true,
- "skipAllValidations": true,
- "useProvidedContractualEndDates": true,
- "source": "SmartPM",
- "dataDate": "2019-08-24T14:15:22Z",
- "projectCreationType": "MANUAL"
}{- "projectId": 0,
- "message": "string",
- "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608"
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| fileId | string <uuid> |
| fileName | string |
| source | string Enum: "SmartPM" "XER" "MPP" "Excel" "PMXML" "PPX" "PP" |
| dataDate | string |
| projectCreationType | string Enum: "MANUAL" "QUALITY_CHECK" "SCHEDULE_COMPARISON" "SCHEDULE_REVIEW" |
{- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "fileName": "string",
- "source": "SmartPM",
- "dataDate": "string",
- "projectCreationType": "MANUAL"
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| fileId | string <uuid> |
| fileName | string |
| source | string Enum: "SmartPM" "XER" "MPP" "Excel" "PMXML" "PPX" "PP" |
| dataDate | string |
| projectCreationType | string Enum: "MANUAL" "QUALITY_CHECK" "SCHEDULE_COMPARISON" "SCHEDULE_REVIEW" |
{- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "fileName": "string",
- "source": "SmartPM",
- "dataDate": "string",
- "projectCreationType": "MANUAL"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| newProjectId | integer <int64> |
Array of objects (ProjectRebuildFileInformation) | |
object | |
| requester | string |
| requesterCompanyName | string |
| aiTenantId | string |
{- "newProjectId": 0,
- "files": [
- {
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "file": "string",
- "originalFileName": "string",
- "dataDate": "2019-08-24T14:15:22Z",
- "skipSubsetValidations": true,
- "importLogHitRateGoal": 0
}
], - "scenarioConfiguration": {
- "property1": "string",
- "property2": "string"
}, - "requester": "string",
- "requesterCompanyName": "string",
- "aiTenantId": "string"
}| projectId required | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| newProjectId | integer <int64> |
Array of objects (ProjectRebuildFileInformation) | |
object | |
| requester | string |
| requesterCompanyName | string |
| aiTenantId | string |
{- "newProjectId": 0,
- "files": [
- {
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "file": "string",
- "originalFileName": "string",
- "dataDate": "2019-08-24T14:15:22Z",
- "skipSubsetValidations": true,
- "importLogHitRateGoal": 0
}
], - "scenarioConfiguration": {
- "property1": "string",
- "property2": "string"
}, - "requester": "string",
- "requesterCompanyName": "string",
- "aiTenantId": "string"
}| projectId required | integer <int64> |
| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string |
| description | string |
| baseScheduleId required | integer <int64> |
| activityIds | Array of integers <int64> |
| ruleIds | Array of integers <int64> |
object | |
| requester | string |
| requesterCompanyName | string |
| makePrimary | boolean |
{- "name": "string",
- "description": "string",
- "baseScheduleId": 0,
- "activityIds": [
- 0
], - "ruleIds": [
- 0
], - "scenarioConfiguration": {
- "property1": "string",
- "property2": "string"
}, - "requester": "string",
- "requesterCompanyName": "string",
- "makePrimary": true
}| companyId required | string |
| X-COMPANY-ID required | string The company's unique ID |
| name required | string non-empty |
| isAnd | boolean |
| type | string Enum: "Company" "CustomReport" "Delay" "Manual" "Rule" "Temporary" |
Array of objects (QueryAddRequest) | |
Array of objects (FilterCreateRequest) | |
Array of objects (FilterCreateRequest) |
{- "name": "string",
- "isAnd": true,
- "type": "Company",
- "queries": [
- {
- "attribute": 0,
- "operator": 0,
- "value": "string",
- "hvalue": "string"
}
], - "subFilters": [
- { }
], - "filters": [
- { }
]
}| X-COMPANY-ID required | string The company's unique ID |
| created | string <date-time> |
| lastUpdated | string <date-time> |
| version | integer <int32> |
| id | string <uuid> |
| firstName | string [ 1 .. 25 ] characters |
| lastName | string |
string <email> | |
| phone | string [ 0 .. 20 ] characters |
| title | string |
object (Login) | |
Array of objects (Role) unique | |
| lastLogin | string <date-time> |
| loginCount | integer <int64> |
| authenticationProvider | string |
| reportingRestricted | boolean |
| fullName | string |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}| X-COMPANY-ID required | string The company's unique ID |
| created | string <date-time> |
| lastUpdated | string <date-time> |
| version | integer <int32> |
| id | string <uuid> |
| firstName | string [ 1 .. 25 ] characters |
| lastName | string |
string <email> | |
| phone | string [ 0 .. 20 ] characters |
| title | string |
object (Login) | |
Array of objects (Role) unique | |
| lastLogin | string <date-time> |
| loginCount | integer <int64> |
| authenticationProvider | string |
| reportingRestricted | boolean |
| fullName | string |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}| id required | string |
| X-COMPANY-ID required | string The company's unique ID |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}| X-COMPANY-ID required | string The company's unique ID |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}| X-COMPANY-ID required | string The company's unique ID |
{- "entities": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}
]
}| X-COMPANY-ID required | string The company's unique ID |
| created | string <date-time> |
| lastUpdated | string <date-time> |
| version | integer <int32> |
| id | string <uuid> |
| name required | string [ 1 .. 100 ] characters |
| type required | string Enum: "Company" "Project" "Site" |
| defaultProjectRoleId | string <uuid> |
Array of objects (Permission) unique | |
| companyId | string <uuid> |
| description | string [ 0 .. 255 ] characters |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}| X-COMPANY-ID required | string The company's unique ID |
| created | string <date-time> |
| lastUpdated | string <date-time> |
| version | integer <int32> |
| id | string <uuid> |
| name required | string [ 1 .. 100 ] characters |
| type required | string Enum: "Company" "Project" "Site" |
| defaultProjectRoleId | string <uuid> |
Array of objects (Permission) unique | |
| companyId | string <uuid> |
| description | string [ 0 .. 255 ] characters |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}| type required | string Enum: "Company" "Project" "Site" |
| X-COMPANY-ID required | string The company's unique ID |
{- "entities": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}
]
}| id required | string |
| X-COMPANY-ID required | string The company's unique ID |
{- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}| X-COMPANY-ID required | string The company's unique ID |
{- "entities": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phone": "string",
- "title": "string",
- "login": {
- "username": "string",
- "password": "stringst",
- "passwordResetToken": "string",
- "credentialsExpired": true
}, - "roles": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "Company",
- "defaultProjectRoleId": "98fd62af-6a4b-474d-8677-84af4521b499",
- "permissions": [
- {
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "version": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "admin"
}
], - "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
- "description": "string"
}
], - "lastLogin": "2019-08-24T14:15:22Z",
- "loginCount": 0,
- "authenticationProvider": "string",
- "reportingRestricted": true,
- "fullName": "string"
}
]
}| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| startOfWindow required | string |
| endOfWindow required | string |
| groupBy | string Default: "NONE" Enum: "NONE" "ACTIVITY_CODE_TYPE" "WBS" |
| activityCodeTypeIds | Array of integers <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| filterWindow | boolean |
| startStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| finishStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| overallStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| startOfWindow required | string |
| endOfWindow required | string |
| groupBy | string Default: "NONE" Enum: "NONE" "ACTIVITY_CODE_TYPE" "WBS" |
| activityCodeTypeIds | Array of integers <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| startStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| finishStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| overallStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| sortBy | string Enum: "CUSTOM_ID" "NAME" "START_WINDOW_START" "START_WINDOW_FINISH" "START_WINDOW_PROGRESS" "START_WINDOW_TOTAL_FLOAT" "END_WINDOW_START" "END_WINDOW_FINISH" "END_WINDOW_PROGRESS" "END_WINDOW_TOTAL_FLOAT" "VARIANCE_START" "VARIANCE_FINISH" "VARIANCE_PROGRESS" "VARIANCE_TOTAL_FLOAT" |
| sortDirection | string Enum: "ASC" "DESC" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| startStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| finishStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| overallStatus | string Enum: "DELETED" "DID_NOT" "LATE" "ON_TIME" "SHOULD_NOT" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| periodMonthDate required | string |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| column required | string Enum: "BaselineStarts" "CurrentStarts" "BaselineFinishes" "CurrentFinishes" |
| periodMonthDate required | string |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| startDate required | string |
| finishDate required | string |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| filterWindow | boolean |
| filter | Array of strings Items Enum: "STARTED_ON_TIME" "STARTED_LATE" "DID_NOT_START" "FINISHED_ON_TIME" "FINISHED_LATE" "DID_NOT_FINISH" "SHOULD_HAVE_STARTED" "SHOULD_HAVE_FINISHED" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| delta | boolean |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| dataDate | string |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| includeDeleted | boolean |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| dataDate | string |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| includeDeleted | boolean |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
Get Schedule Update Volume Trend (V2)
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
Get Company Schedule Performance Index Trend (V2)
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
Get Company Schedule Compression Trend (V2)
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
Get Company Quality Trend (V2)
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
Get Company Project Health Trend (V2)
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
Get Company Hit Rate Trend (V2)
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| includeMilestones | boolean Default: false |
| filters | Array of strings |
| searchTerm | string |
| sortByColumn | string Enum: "ACTUAL_PROGRESS" "AVERAGE_DURATION_VARIANCE" "BASELINE_ACTUAL_PROGRESS" "BASELINE_AVERAGE_DURATION_VARIANCE" "BASELINE_CONTRACTUAL_END_DATE" "BASELINE_CONTRACTUAL_FLOAT" "BASELINE_COST_ACTUAL_PROGRESS" "BASELINE_COST_EARNED" "BASELINE_COST_PERFORMANCE_INDEX" "BASELINE_COST_PLANNED" "BASELINE_COST_PLANNED_PROGRESS" "BASELINE_COST_REMAINING" "BASELINE_DATA_DATE" "BASELINE_DURATION" "BASELINE_EARNED_DAYS" "BASELINE_END_DATE" "BASELINE_HEALTH" "BASELINE_MANPOWER_ACTUAL" "BASELINE_MANPOWER_ACTUAL_PROGRESS" "BASELINE_MANPOWER_EARNED" "BASELINE_MANPOWER_ESTIMATED" "BASELINE_MANPOWER_PERFORMANCE_INDEX" "BASELINE_MANPOWER_PLANNED" "BASELINE_MANPOWER_PLANNED_PROGRESS" "BASELINE_PLANNED_PROGRESS" "BASELINE_PLANNED_RECOVERY" "BASELINE_PREDICTED_END_DATE" "BASELINE_SCHEDULE_QUALITY" "BASELINE_SOURCE_END_DATE" "BASELINE_SPI" "CITY" "COMPRESSION" "CONTRACTUAL_END_DATE" "CONTRACTUAL_END_DATE_VARIANCE" "CONTRACTUAL_FLOAT" "COST_ACTUAL_PROGRESS" "COST_EARNED" "COST_PERFORMANCE_INDEX" "COST_PLANNED" "COST_PLANNED_PROGRESS" "COST_REMAINING" "COUNTRY" "CRITICAL_PATH_DELAY" "CURRENT_END_DATE" "DATA_DATE" "DURATION" "DURATION_VARIANCE" "EARNED_DAYS" "END_DATE_VARIANCE" "HEALTH" "HIT_RATE" "MANPOWER_ACTUAL" "MANPOWER_ACTUAL_PROGRESS" "MANPOWER_EARNED" "MANPOWER_ESTIMATED" "MANPOWER_PERFORMANCE_INDEX" "MANPOWER_PLANNED" "MANPOWER_PLANNED_PROGRESS" "MILESTONE" "NAME" "PLANNED_END_DATE" "PLANNED_PROGRESS" "PLANNED_RECOVERY" "POSTAL_CODE" "PREDICTED_END_DATE" "PREVIOUS_ACTUAL_PROGRESS" "PREVIOUS_AVERAGE_DURATION_VARIANCE" "PREVIOUS_COMPRESSION" "PREVIOUS_CONTRACTUAL_END_DATE" "PREVIOUS_CONTRACTUAL_END_DATE_VARIANCE" "PREVIOUS_CONTRACTUAL_FLOAT" "PREVIOUS_COST_ACTUAL_PROGRESS" "PREVIOUS_COST_EARNED" "PREVIOUS_COST_PERFORMANCE_INDEX" "PREVIOUS_COST_PLANNED" "PREVIOUS_COST_PLANNED_PROGRESS" "PREVIOUS_COST_REMAINING" "PREVIOUS_CRITICAL_PATH_DELAY" "PREVIOUS_DATA_DATE" "PREVIOUS_DURATION" "PREVIOUS_DURATION_VARIANCE" "PREVIOUS_EARNED_DAYS" "PREVIOUS_END_DATE" "PREVIOUS_END_DATE_VARIANCE" "PREVIOUS_HEALTH" "PREVIOUS_HIT_RATE" "PREVIOUS_MANPOWER_ACTUAL" "PREVIOUS_MANPOWER_ACTUAL_PROGRESS" "PREVIOUS_MANPOWER_EARNED" "PREVIOUS_MANPOWER_ESTIMATED" "PREVIOUS_MANPOWER_PERFORMANCE_INDEX" "PREVIOUS_MANPOWER_PLANNED" "PREVIOUS_MANPOWER_PLANNED_PROGRESS" "PREVIOUS_PLANNED_PROGRESS" "PREVIOUS_PLANNED_RECOVERY" "PREVIOUS_PREDICTED_END_DATE" "PREVIOUS_SCHEDULE_QUALITY" "PREVIOUS_SOURCE_END_DATE" "PREVIOUS_SPI" "PROGRESS" "QUALITY_PROFILE" "SCHEDULE_QUALITY" "SLIPPAGE" "SOURCE_END_DATE" "SPI" "START_DATE" "START_DATE_VARIANCE" "STATE" |
| sortDirection | string Enum: "ASC" "DESC" |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| projectListTableColumns required | Array of strings Items Enum: "ACTUAL_PROGRESS" "AVERAGE_DURATION_VARIANCE" "BASELINE_ACTUAL_PROGRESS" "BASELINE_AVERAGE_DURATION_VARIANCE" "BASELINE_CONTRACTUAL_END_DATE" "BASELINE_CONTRACTUAL_FLOAT" "BASELINE_COST_ACTUAL_PROGRESS" "BASELINE_COST_EARNED" "BASELINE_COST_PERFORMANCE_INDEX" "BASELINE_COST_PLANNED" "BASELINE_COST_PLANNED_PROGRESS" "BASELINE_COST_REMAINING" "BASELINE_DATA_DATE" "BASELINE_DURATION" "BASELINE_EARNED_DAYS" "BASELINE_END_DATE" "BASELINE_HEALTH" "BASELINE_MANPOWER_ACTUAL" "BASELINE_MANPOWER_ACTUAL_PROGRESS" "BASELINE_MANPOWER_EARNED" "BASELINE_MANPOWER_ESTIMATED" "BASELINE_MANPOWER_PERFORMANCE_INDEX" "BASELINE_MANPOWER_PLANNED" "BASELINE_MANPOWER_PLANNED_PROGRESS" "BASELINE_PLANNED_PROGRESS" "BASELINE_PLANNED_RECOVERY" "BASELINE_PREDICTED_END_DATE" "BASELINE_SCHEDULE_QUALITY" "BASELINE_SOURCE_END_DATE" "BASELINE_SPI" "CITY" "COMPRESSION" "CONTRACTUAL_END_DATE" "CONTRACTUAL_END_DATE_VARIANCE" "CONTRACTUAL_FLOAT" "COST_ACTUAL_PROGRESS" "COST_EARNED" "COST_PERFORMANCE_INDEX" "COST_PLANNED" "COST_PLANNED_PROGRESS" "COST_REMAINING" "COUNTRY" "CRITICAL_PATH_DELAY" "CURRENT_END_DATE" "DATA_DATE" "DURATION" "DURATION_VARIANCE" "EARNED_DAYS" "END_DATE_VARIANCE" "HEALTH" "HIT_RATE" "MANPOWER_ACTUAL" "MANPOWER_ACTUAL_PROGRESS" "MANPOWER_EARNED" "MANPOWER_ESTIMATED" "MANPOWER_PERFORMANCE_INDEX" "MANPOWER_PLANNED" "MANPOWER_PLANNED_PROGRESS" "MILESTONE" "NAME" "PLANNED_END_DATE" "PLANNED_PROGRESS" "PLANNED_RECOVERY" "POSTAL_CODE" "PREDICTED_END_DATE" "PREVIOUS_ACTUAL_PROGRESS" "PREVIOUS_AVERAGE_DURATION_VARIANCE" "PREVIOUS_COMPRESSION" "PREVIOUS_CONTRACTUAL_END_DATE" "PREVIOUS_CONTRACTUAL_END_DATE_VARIANCE" "PREVIOUS_CONTRACTUAL_FLOAT" "PREVIOUS_COST_ACTUAL_PROGRESS" "PREVIOUS_COST_EARNED" "PREVIOUS_COST_PERFORMANCE_INDEX" "PREVIOUS_COST_PLANNED" "PREVIOUS_COST_PLANNED_PROGRESS" "PREVIOUS_COST_REMAINING" "PREVIOUS_CRITICAL_PATH_DELAY" "PREVIOUS_DATA_DATE" "PREVIOUS_DURATION" "PREVIOUS_DURATION_VARIANCE" "PREVIOUS_EARNED_DAYS" "PREVIOUS_END_DATE" "PREVIOUS_END_DATE_VARIANCE" "PREVIOUS_HEALTH" "PREVIOUS_HIT_RATE" "PREVIOUS_MANPOWER_ACTUAL" "PREVIOUS_MANPOWER_ACTUAL_PROGRESS" "PREVIOUS_MANPOWER_EARNED" "PREVIOUS_MANPOWER_ESTIMATED" "PREVIOUS_MANPOWER_PERFORMANCE_INDEX" "PREVIOUS_MANPOWER_PLANNED" "PREVIOUS_MANPOWER_PLANNED_PROGRESS" "PREVIOUS_PLANNED_PROGRESS" "PREVIOUS_PLANNED_RECOVERY" "PREVIOUS_PREDICTED_END_DATE" "PREVIOUS_SCHEDULE_QUALITY" "PREVIOUS_SOURCE_END_DATE" "PREVIOUS_SPI" "PROGRESS" "QUALITY_PROFILE" "SCHEDULE_QUALITY" "SLIPPAGE" "SOURCE_END_DATE" "SPI" "START_DATE" "START_DATE_VARIANCE" "STATE" |
| X-COMPANY-ID required | string The company's unique ID |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| metricType required | string Enum: "ACTIVITIES_TOTAL" "ACTIVITIES_MILESTONES" "ACTIVITIES_ACTIVITIES" "ACTIVITY_NAME_CHANGES" "RELATIONSHIPS_TOTAL" "RELATIONSHIPS_START_TO_FINISH" "RELATIONSHIPS_START_TO_START" "RELATIONSHIPS_FINISH_TO_START" "RELATIONSHIPS_FINISH_TO_FINISH" "MISSING_LOGIC" "LAG_NEGATIVE" "LAG_POSITIVE" "CONSTRAINTS_TOTAL" "CONSTRAINTS_HARD" "CONSTRAINTS_SOFT" "CONSTRAINT_BREAKING_LOGIC" "LOW_FLOAT_ACTIVITIES" "HIGH_FLOAT_ACTIVITIES" "HIGH_DURATION_ACTIVITIES" "RESOURCE_LOADED_ACTIVITIES" "CRITICAL_PATH_PERCENT" "AVG_ACTIVITY_TOTAL_FLOAT" "SCHEDULE_COMPRESSION_INDEX" "IMPORT_CHANGE_STARTED_NO_PROGRESS" "IMPORT_CHANGE_FUTURE_ACTUAL_DATES" "IMPORT_CHANGE_COMPLETE_BUT_NO_ACTUAL_FINISH_DATE" "IMPORT_CHANGE_CHANGED_ACTUAL_DATES" "IMPORT_CHANGE_DECREASED_PERCENT_COMPLETE" "INVALID_FORECAST_DATE" "MANUALLY_SCHEDULED_ACTIVITIES" "DANGLING_ACTIVITIES" "MANUALLY_SCHEDULED_SUMMARIES" "DUPLICATE_RELATIONSHIPS" "DUPLICATE_ACTIVITY_NAMES" "IMPORT_CHANGE_LOGIC_TIE_GENERATION" "IMPORT_CHANGE_SUMMARY_ASSIGNED_LOGIC" "REMAINING_DURATION_DISCREPANCY" "PROGRESS_OUT_OF_SEQUENCE" "ACTIVITIES_RIDING_DATADATE" "ACTIVITIES_SITTING_DATADATE" "ONE_DAY_ACTIVITIES" "BACKDATED_ACTIVITIES" "ACTIVITIES_LATER_THAN_TRACKED_TO" "LOE_ACTIVITIES" "IMPORT_CHANGE_INCREASED_REMAINING_DURATION" "NEGATIVE_NATIVE_FLOAT" "CONVERGENCE_BOTTLENECKS" "DIVERGENCE_BOTTLENECKS" "FINISH_TO_START_RELATIONSHIP_WITH_LAG" "BASELINE_EXECUTION_INDEX" "MISSED_TASKS" "CRITICAL_PATH_LENGTH_INDEX" "CRITICAL_PATH_TEST" |
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| periodType required | string Enum: "BY_PERIOD" "BY_MONTH" |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| filters | Array of strings |
| qualityProfileId | integer <int64> |
| projectMetricFilter | string Enum: "PROJECTS_DELAYED" "PROJECTS_ON_TRACK" "PROJECTS_NEEDING_UPDATES" "PROJECTS_LOW_QUALITY" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| scenarioFilterId | Array of integers <int64> |
| importLogId | integer <int64> |
| qualityProfileId | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| metricType required | string Enum: "ACTIVITIES_TOTAL" "ACTIVITIES_MILESTONES" "ACTIVITIES_ACTIVITIES" "ACTIVITY_NAME_CHANGES" "RELATIONSHIPS_TOTAL" "RELATIONSHIPS_START_TO_FINISH" "RELATIONSHIPS_START_TO_START" "RELATIONSHIPS_FINISH_TO_START" "RELATIONSHIPS_FINISH_TO_FINISH" "MISSING_LOGIC" "LAG_NEGATIVE" "LAG_POSITIVE" "CONSTRAINTS_TOTAL" "CONSTRAINTS_HARD" "CONSTRAINTS_SOFT" "CONSTRAINT_BREAKING_LOGIC" "LOW_FLOAT_ACTIVITIES" "HIGH_FLOAT_ACTIVITIES" "HIGH_DURATION_ACTIVITIES" "RESOURCE_LOADED_ACTIVITIES" "CRITICAL_PATH_PERCENT" "AVG_ACTIVITY_TOTAL_FLOAT" "SCHEDULE_COMPRESSION_INDEX" "IMPORT_CHANGE_STARTED_NO_PROGRESS" "IMPORT_CHANGE_FUTURE_ACTUAL_DATES" "IMPORT_CHANGE_COMPLETE_BUT_NO_ACTUAL_FINISH_DATE" "IMPORT_CHANGE_CHANGED_ACTUAL_DATES" "IMPORT_CHANGE_DECREASED_PERCENT_COMPLETE" "INVALID_FORECAST_DATE" "MANUALLY_SCHEDULED_ACTIVITIES" "DANGLING_ACTIVITIES" "MANUALLY_SCHEDULED_SUMMARIES" "DUPLICATE_RELATIONSHIPS" "DUPLICATE_ACTIVITY_NAMES" "IMPORT_CHANGE_LOGIC_TIE_GENERATION" "IMPORT_CHANGE_SUMMARY_ASSIGNED_LOGIC" "REMAINING_DURATION_DISCREPANCY" "PROGRESS_OUT_OF_SEQUENCE" "ACTIVITIES_RIDING_DATADATE" "ACTIVITIES_SITTING_DATADATE" "ONE_DAY_ACTIVITIES" "BACKDATED_ACTIVITIES" "ACTIVITIES_LATER_THAN_TRACKED_TO" "LOE_ACTIVITIES" "IMPORT_CHANGE_INCREASED_REMAINING_DURATION" "NEGATIVE_NATIVE_FLOAT" "CONVERGENCE_BOTTLENECKS" "DIVERGENCE_BOTTLENECKS" "FINISH_TO_START_RELATIONSHIP_WITH_LAG" "BASELINE_EXECUTION_INDEX" "MISSED_TASKS" "CRITICAL_PATH_LENGTH_INDEX" "CRITICAL_PATH_TEST" |
| importLogId | integer <int64> |
| filterId | Array of integers <int64> |
| qualityProfileId | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| metric required | string Enum: "CriticalChanges" "NearCriticalChanges" "ActivityChanges" "ActivitiesAdded" "ActivitiesDeleted" "LogicChanges" "DurationChanges" "DelayedActivityChanges" "AllCalendarChanges" "CalendarChanges" "WorkingDayChanges" "FlaggedChanges" |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
Change log summaries grouped by the activity codes of a single activity code type. The key is the activityCodeId and the value is the same list the Change Log Summary endpoint returns, restricted to activities carrying that code.
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| activityCodeTypeId required | integer <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| activityCodeTypeId required | integer <int64> |
| activityCodeId required | integer <int64> |
| X-COMPANY-ID required | string |
| X-COMPANY-ID required | string The company's unique ID |
| timeFrom | string <date-time> |
| timeTo | string <date-time> |
| pageSize | integer <int32> Default: 20 |
| pageNumber | integer <int32> Default: 0 |
| smartPmEvents | Array of strings |
| messageContains | string |
| actorUserName | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| dataDate | string |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| dataDate | string |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| activityColumns required | Array of strings Items Enum: "ID" "NAME" "START_DATE" "END_DATE" "DURATION" "TOTAL_FLOAT" "CURRENT_FORECAST_FINISH" "FINISH_VARIANCE" "SUCCESSORS" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| activityCodeColumns required | Array of strings Items Enum: "START_DATE" "END_DATE" "DURATION" "TOTAL_FLOAT" "CURRENT_FORECAST_FINISH" "START_VARIANCE" "FINISH_VARIANCE" "RISK_INDEX" "DURATION_VARIANCE" "DURATION_VARIANCE_PERCENT" "SUCCESSORS" "PREDECESSORS" "SPI" "PLANNED_VS_ACTUAL" "INTERCONNECTIONS" "REMAINING_ACTIVITIES" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| trade | string |
| activityCodeFilter | Array of integers <int64> |
| lookAheadFilterId | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| sortColumn | string Enum: "MILESTONE" "BASELINEDATE" "CURRENTDATE" "VARIANCE" "FORECASTEDDATE" "COMPRESSION" |
| sortDirection | string Enum: "ASC" "DESC" |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| metric required | string Enum: "ACTIVITIES_TOTAL" "ACTIVITIES_MILESTONES" "ACTIVITIES_ACTIVITIES" "ACTIVITY_NAME_CHANGES" "RELATIONSHIPS_TOTAL" "RELATIONSHIPS_START_TO_FINISH" "RELATIONSHIPS_START_TO_START" "RELATIONSHIPS_FINISH_TO_START" "RELATIONSHIPS_FINISH_TO_FINISH" "MISSING_LOGIC" "LAG_NEGATIVE" "LAG_POSITIVE" "CONSTRAINTS_TOTAL" "CONSTRAINTS_HARD" "CONSTRAINTS_SOFT" "CONSTRAINT_BREAKING_LOGIC" "LOW_FLOAT_ACTIVITIES" "HIGH_FLOAT_ACTIVITIES" "HIGH_DURATION_ACTIVITIES" "RESOURCE_LOADED_ACTIVITIES" "CRITICAL_PATH_PERCENT" "AVG_ACTIVITY_TOTAL_FLOAT" "SCHEDULE_COMPRESSION_INDEX" "IMPORT_CHANGE_STARTED_NO_PROGRESS" "IMPORT_CHANGE_FUTURE_ACTUAL_DATES" "IMPORT_CHANGE_COMPLETE_BUT_NO_ACTUAL_FINISH_DATE" "IMPORT_CHANGE_CHANGED_ACTUAL_DATES" "IMPORT_CHANGE_DECREASED_PERCENT_COMPLETE" "INVALID_FORECAST_DATE" "MANUALLY_SCHEDULED_ACTIVITIES" "DANGLING_ACTIVITIES" "MANUALLY_SCHEDULED_SUMMARIES" "DUPLICATE_RELATIONSHIPS" "DUPLICATE_ACTIVITY_NAMES" "IMPORT_CHANGE_LOGIC_TIE_GENERATION" "IMPORT_CHANGE_SUMMARY_ASSIGNED_LOGIC" "REMAINING_DURATION_DISCREPANCY" "PROGRESS_OUT_OF_SEQUENCE" "ACTIVITIES_RIDING_DATADATE" "ACTIVITIES_SITTING_DATADATE" "ONE_DAY_ACTIVITIES" "BACKDATED_ACTIVITIES" "ACTIVITIES_LATER_THAN_TRACKED_TO" "LOE_ACTIVITIES" "IMPORT_CHANGE_INCREASED_REMAINING_DURATION" "NEGATIVE_NATIVE_FLOAT" "CONVERGENCE_BOTTLENECKS" "DIVERGENCE_BOTTLENECKS" "FINISH_TO_START_RELATIONSHIP_WITH_LAG" "BASELINE_EXECUTION_INDEX" "MISSED_TASKS" "CRITICAL_PATH_LENGTH_INDEX" "CRITICAL_PATH_TEST" |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| selectedActivityCodeIds required | Array of integers <int64> |
| filterId | Array of integers <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| activityCodeId required | integer <int64> |
| relatedActivityCodeId required | integer <int64> |
| dependencyDirection required | string Enum: "PREDECESSOR" "SUCCESSOR" |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| selectedActivityCodeIds required | Array of integers <int64> |
| viewType | string Default: "YEAR" Enum: "YEAR" "QUARTER" "MONTH" "DAY" |
| scopeStartDate | string |
| scopeFinishDate | string |
| dataDate | string |
| filterId | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| activityCodeTypeId required | integer <int64> |
| filterId | Array of integers <int64> |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| activityCodeTypeId required | integer <int64> |
| activityCodeId required | integer <int64> |
| filterId | Array of integers <int64> |
| dataDate required | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| asOfDate | string |
| percentCompleteCalculationType required | string Enum: "Duration" "Resource" "Cost" "Overall" |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| asOfDate | string |
| percentCompleteCalculationType required | string Enum: "Duration" "Resource" "Cost" "Overall" |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| asOfDate | string |
| percentCompleteCalculationType required | string Enum: "Duration" "Resource" "Cost" "Overall" |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| asOfDate | string |
| percentCompleteCalculationType required | string Enum: "Duration" "Resource" "Cost" "Overall" |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| asOfDate | string |
| percentCompleteCalculationType required | string Enum: "Duration" "Resource" "Cost" "Overall" |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| metric required | string Enum: "CalendarChanges" "WorkingDayChanges" "HourConflicts" "ExtendedNoWork" |
| dataDate | string |
| X-COMPANY-ID required | string The company's unique ID |
| projectId required | integer <int64> |
| scenarioId required | integer <int64> |
| filterId | Array of integers <int64> |
| activityCodeFilter | Array of integers <int64> |
| dataDate | string |
| includeDeleted | boolean |
| X-COMPANY-ID required | string The company's unique ID |
| fromTimestamp | string |
| toTimestamp | string |
| pageSize | integer <int32> |
| pageNumber | integer <int32> |
| notificationTypes | Array of strings Items Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| X-COMPANY-ID required | string The company's unique ID |
| fromTimestamp | string |
| toTimestamp | string |
| pageSize | integer <int32> |
| pageNumber | integer <int32> |
| notificationTypes | Array of strings Items Enum: "ALL_ANALYSIS" "CHECKLIST" "CLASSIFY_SCHEDULE" "DELAY_ANALYSIS" "EXECUTIVE" "FILE_EXPORT" "FILE_IMPORT" "INTEGRATION_SYNC_DATATYPE" "INTEGRATION_FILE_DOWNLOAD" "INTEGRATION_FILE_VALIDATION" "INTEGRATION_FILE_SYNC" "MODEL_CREATE" "MODEL_UPDATE" "PLANNED_CURVE" "PROJECT_BASELINE" "PROJECT_IMPORT" "PROJECT_REBUILD" "SCENARIO_CREATE" "SCENARIO_UPDATE" "SCHEDULE_REVIEW" |
| X-COMPANY-ID required | string The company's unique ID |
| companyId required | string |
| reportId required | integer <int32> |
| isAttachment required | boolean |
| reportType | string Enum: "CHANGES" "CUSTOM" "CUSTOM_EXECUTIVE" "DELAY_TABLE" "EXECUTIVE_DASHBOARD" "GANTT" "NARRATIVE" "PINK" "PROJECT_SUMMARY" "QUALITY" "QUALITY_THRESHOLD" "RFIS" "SUBMITTALS" "SUMMARY" "SHOULD_START_AND_FINISH" "TREND_CHARTS" "VELOCITY" |
| profileId | integer <int64> |
| X-COMPANY-ID required | string The company's unique ID |