openapi: 3.0.0 info: title: HeavyBid Estimate Insights API description: Integrate with synced HeavyBid data. Operations require the 'heavybid:read' scope. termsOfService: https://support.hcss.com. contact: name: Heavy Construction Systems Specialists, Inc. (HCSS) url: https://support.hcss.com/ email: support@hcss.com license: name: EULA url: https://support.hcss.com. version: v2 servers: - url: https://api.hcssapps.com/heavybid security: - bearer: - heavybid:read - heavybid:write - heavybid:system:read - heavybid:system:write paths: /api/v2/integration/businessunits/{businessUnitId}/activities: get: tags: - Activities summary: Get All Activities description: |- Get All Activities For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllActivityAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: includeExcludedEstimates in: query description: Whether the pull biditems that have been marked as "excluded" and are not used in calculations. schema: type: boolean default: false x-position: 3 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfActivityIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/activities/{id}: get: tags: - Activities summary: Get an Activity by Id description: |- Get an Activity by Id For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetActivity parameters: - name: id in: path required: true description: The required activity id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfActivityIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/activitycodebook: get: tags: - Activity Codebook summary: Retrieves all activity codebook activities for a business unit. description: |- Retrieves all activity codebook activities for a business unit. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllActivityCodebookAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfActivityCodebookIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/activitycodebook/{id}: get: tags: - Activity Codebook summary: Retrieves a specific activity codebook activity by its id. description: |- Retrieves a specific activity codebook activity by its id. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetActivityCodebookById parameters: - name: id in: path required: true description: The required activity codebook activity id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfActivityCodebookIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/activitycodebookresource: get: tags: - Activity Codebook Resources summary: Retrieves all activity codebook resources for a business unit. description: |- Retrieves all activity codebook resources for a business unit. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllActivityCodebookResourcesAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfActivityCodebookResourceIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/activitycodebookresource/{id}: get: tags: - Activity Codebook Resources summary: Retrieves a specific activity codebook resource by its id. description: |- Retrieves a specific activity codebook resource by its id. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetActivityCodebookResourceById parameters: - name: id in: path required: true description: The required activity codebook resource id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfActivityCodebookResourceIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/estimates/{estimateId}/attachments: get: tags: - Attachments summary: Get Estimate Attachments description: |- Get Estimate Attachments For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetEstimateAttachments parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 1 - name: estimateId in: path required: true description: The required estimate id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfAttachmentIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/estimates/{estimateId}/attachments/{attachmentId}: get: tags: - Attachments summary: Download an Estimate Attachment by Id description: |- Download an Estimate Attachment by Id For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_DownloadEstimateAttachment parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 1 - name: estimateId in: path required: true description: The required estimate id. schema: type: string format: guid x-position: 2 - name: attachmentId in: path required: true description: The required attachment id. schema: type: string format: guid x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/File' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/biditemcodebook: get: tags: - Biditem Codebook summary: Retrieves all biditem codebook biditems for a business unit. description: |- Retrieves all biditem codebook biditems for a business unit. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllBiditemCodebookAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfBiditemCodebookIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/biditemcodebook/{id}: get: tags: - Biditem Codebook summary: Retrieves a specific biditem codebook biditem by its id. description: |- Retrieves a specific biditem codebook biditem by its id. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetBiditemCodebookById parameters: - name: id in: path required: true description: The required biditem codebook biditem id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfBiditemCodebookIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/biditems: get: tags: - Biditems summary: Get All Biditems description: |- Get All Biditems For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllBidItemsAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: includeExcludedEstimates in: query description: Whether to pull biditems that have been marked as "excluded" and are not used in calculations. schema: type: boolean default: false x-position: 3 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfBiditemIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/biditems/{id}: get: tags: - Biditems summary: Get a Biditem by Id description: |- Get a Biditem by Id For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetBidItem parameters: - name: id in: path required: true description: The required biditem id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfBiditemIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits: get: tags: - Business Units summary: Get All Business Units description: |- Get All Business Units This is typically the first API call made. Most of the other routes require a specific business unit id to be passed in. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllBusinessUnitsAsync responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfApiBusinessUnitRead' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/estimates: get: tags: - Estimates summary: Get All Estimates description: |- Get All Estimates For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllEstimatesAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: includeExcludedEstimates in: query description: Whether to include excluded estimates. schema: type: boolean default: false x-position: 3 - name: includeDeletedEstimates in: query description: Whether to include deleted estimates. schema: type: boolean default: false x-position: 4 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfEstimateIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/estimates/{id}: get: tags: - Estimates summary: Get an Estimate by Id description: |- Get an Estimate by Id For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetEstimate parameters: - name: id in: path required: true description: The required id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfEstimateIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/estimates/{id}/kpis: get: tags: - Estimates summary: Get Key Indicators for an Estimate description: |- Get Key Indicators for an Estimate For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllCalulatedKPIs parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 1 - name: id in: path required: true description: The required estimate id. schema: type: string format: guid x-position: 2 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfKPI' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/materialcodebook: get: tags: - Material Codebook summary: Retrieves all material codebook resources for a business unit. description: |- Retrieves all material codebook resources for a business unit. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllMaterialCodebookResourcesAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfMaterialCodebookIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/materialcodebook/{id}: get: tags: - Material Codebook summary: Retrieves a specific material codebook resource by its id. description: |- Retrieves a specific material codebook resource by its id. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetMaterialCodebookResourceById parameters: - name: id in: path required: true description: The required material codebook resource id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfMaterialCodebookIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] put: tags: - Material Codebook summary: Replace a specific material codebook resource by its id. description: |- Replace a specific material codebook resource by its id. For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_UpdateMaterialCodebookResourceById parameters: - name: id in: path required: true description: The required material codebook resource id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 requestBody: x-name: dto description: The new material codebook resource to replace the old one with. content: application/json: schema: $ref: '#/components/schemas/MaterialCodebookIntegrationUpdateDto' required: true x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfMaterialCodebookIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/partitions: get: tags: - Partitions summary: Get All Database Partitions description: |- Get All Database Partitions For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllDatabasePartitionsAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfApiDatabasePartitionRead' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/partitions/{id}: get: tags: - Partitions summary: Get a Database Partition by Id description: |- Get a Database Partition by Id For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetDatabasePartitionById parameters: - name: id in: path required: true description: The required id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfApiDatabasePartitionRead' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/resources: get: tags: - Resources summary: Get All Resources description: |- Get All Resources For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetAllResourcesAsync parameters: - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 - name: includeExcludedEstimates in: query description: Whether the pull biditems that have been marked as "excluded" and are not used in calculations. schema: type: boolean default: false x-position: 3 - name: $top in: query description: The max number of records. (e.g. $top=10) schema: type: string default: '' - name: $skip in: query description: The number of records to skip. (e.g. $skip=5) schema: type: string default: '' - name: $filter in: query description: A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b) schema: type: string default: '' - name: $orderby in: query description: Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc) schema: type: string default: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseOfResourceIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] /api/v2/integration/businessunits/{businessUnitId}/resources/{id}: get: tags: - Resources summary: Get a Resource by Id description: |- Get a Resource by Id For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens operationId: IntegrationsV2Controller_GetResourceById parameters: - name: id in: path required: true description: The required resource id. schema: type: string format: guid x-position: 1 - name: businessUnitId in: path required: true description: The required business unit id. schema: type: string format: guid x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IntegrationResponseSingleOfResourceIntegrationDto' '401': description: Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information. '403': description: Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information. security: - bearer: [] components: schemas: IntegrationResponseOfActivityIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/ActivityIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 ActivityIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique activity id. format: guid example: 2cf04cfb-7f3d-4456-9bd7-7513c725f5fc estimateId: type: string description: The unique estimate id. format: guid example: 483e8356-7c9d-4949-b882-154072a8e38a estimateCode: type: string description: The HeavyBid estimate code. nullable: true example: 1-BRIDGE lastModified: type: string description: The last modified date. format: date-time example: '2022-02-10T03:09:48Z' biditemId: type: string description: The unique biditem id. format: guid example: db7284b1-b1d2-4eb3-9361-dfc88aa36bab activityCode: type: string description: The HeavyBid activity code. nullable: true example: 290001 biditemCode: type: string description: The HeavyBid biditem code. nullable: true example: 140 description: type: string description: The description. nullable: true example: Install Silt Fence quantity: type: number description: The quantity. format: decimal example: 45000 units: type: string description: The unit of measure. nullable: true example: LF factorable: type: string description: |- By default, activities are factorable if there are bid/takeoff differences. For advanced and comp systems, on the Treeview > Misc tab the user can uncheck factorable to retain the cost. An example of this would be a flat fee that has no regard for quantity. nullable: true example: 'Y' workersCompCode: type: string description: Workers compensation code used in this activity. nullable: true example: TX6217 marineWorkersComp: type: string description: The marine worker's comp code. nullable: true example: L summaryCode: type: string description: The summary code. nullable: true example: EXC calendar: type: string description: The calendar. nullable: true example: 50S hoursPerDay: type: number description: |- Number of hours/day of work performed in this activity. It will come from the calendar used in the activity. If no calendar is used, it will use the hours/day in the calendar setup or the user can just type it in if no calendar is used. format: decimal example: 10 crew: type: string description: The crew code. nullable: true example: EC crewHours: type: number description: Crew hours. A crew hour is 1 hour of all the labor used in the crew (so four labor hours in a crew working one hour would be one crew hour). format: decimal example: 450 crewPercent: type: number description: Crew percent. Used to calculate overtime percent for labor in a crew assigned to an Activity with no calendar. Most activities with crews will have default to 100.00 unless it is changed by the user on the modify crew screen. format: decimal example: 0 productionType: type: string description: |- The production type. Production type must be one of the following: UH - Units per crew hour HU - Crew hours per unit MU - Man hours per unit UM - Units per man hour $U - Cost per unit S - Shifts US - Units per shift SU - Shifts per unit CH - Crew hours RF- Resource factoring (only if the preference to use this feature is turned on) nullable: true example: UH productionRate: type: number description: Rate of production to be used in the calculations for the crew. This value will mean different things depending on the ProductionRate format: decimal example: 100 user1: type: number description: The user defined quantity 1. format: decimal example: 0 user2: type: number description: The user defined quantity 2. format: decimal example: 0 user3: type: number description: The user defined quantity 3. format: decimal example: 0 user4: type: number description: The user defined quantity 4. format: decimal example: 0 accountingJCCode1: type: string description: The accounting code 1. nullable: true example: 290001 accountingJCCode2: type: string description: The accounting code 2. nullable: true example: 140 alternateCostCode: type: string description: The alternate cost code. nullable: true example: 2900 resourceFactorRiskPercent: type: number description: |- When ProductionType=RF, ResourceFactorRiskPercent is used to calculate the labor hours in relation to the MH/Unit set for the material in that activity. (Labor hours will equal ResourceFactorRiskPercent times “MH/Unit”.)" format: decimal example: 100 efficientPercent: type: number description: The crew efficiency factor can be used to account for differences in crew productivity in different areas or environments, without needing to set up a different crew for each condition, or without manually figuring out a new production rate. format: decimal example: 100 calculatedDuration: type: number description: The number of days/shifts the activity will take to complete. format: decimal example: 45 modifiedCrew: type: string description: Flag that signals the crew was modified to be different than the default crew setup. nullable: true example: 'N' userFlag1: type: string description: The user flag 1. nullable: true example: 'Y' userFlag2: type: string description: The user flag 2. nullable: true example: 'Y' manHours: type: number description: Total number of labor hours in the activity. Labor must have a unit of measure of MH to be counted. format: decimal example: 2475 directTotal: type: number description: The direct total. format: decimal example: 121246.49 crewCost: type: number description: The total crew cost. format: decimal example: 50496.49 crewCost_WithMaterial: type: number description: The total crew cost with material. format: decimal example: 50496.49 notes: type: string description: The notes. nullable: true example: '' reportGroup1: type: string description: The report group1. nullable: true example: '' reportGroup2: type: string description: The report group2. nullable: true example: '' reportGroup3: type: string description: The report group3. nullable: true example: '' reportGroup4: type: string description: The report group4. nullable: true example: '' reportGroup5: type: string description: The report group5. nullable: true example: '' reportGroup6: type: string description: The report group6. nullable: true example: '' factor: type: number description: The factor. format: decimal example: 1 days: type: number description: The days. format: decimal example: 0 labor: type: number description: The total labor. format: decimal example: 33210 burden: type: number description: The total burden. format: decimal example: 10588.24 permanentMaterial: type: number description: The total permanent material. format: decimal example: 70750 constructionMaterial: type: number description: The total construction material. format: decimal example: 0 subcontract: type: number description: The total subcontract. format: decimal example: 0 equipmentOperatingExpense: type: number description: The total equipment operating expense. format: decimal example: 1775.23 companyEquipment: type: number description: The total company equipment. format: decimal example: 4923.02 rentedEquipment: type: number description: The total rented equipment format: decimal example: 0 misc1: type: number description: The total misc1. format: decimal example: 0 misc2: type: number description: The total misc2. format: decimal example: 0 misc3: type: number description: The total misc3. format: decimal example: 0 accountingRevenueCode: type: string description: The accounting revenue code. nullable: true example: 290001 accountingDescription: type: string description: The accounting description. nullable: true example: '' accountingQuantity: type: number description: The accounting quantity. format: decimal example: 0 accountingUnits: type: string description: The accounting units. nullable: true example: '' accountingChangeOrder: type: string description: The accounting change order. nullable: true example: '' heavyJobCode: type: string description: The HeavyJob code. nullable: true example: '' heavyJobDescription: type: string description: The HeavyJob description nullable: true example: '' heavyJobQuantity: type: number description: The HeavyJob quantity. format: decimal example: 0 heavyJobUnit: type: string description: The HeavyJob unit. nullable: true example: '' addQuantity: type: string description: The add quantity. nullable: true example: 'N' alternateDescription: type: string description: The alternate description. nullable: true example: '' safetyCode: type: string description: The safety code. nullable: true example: '' cpmPriorItem: type: string description: The CPM prior item. nullable: true example: '' schedulingEquivalentCPMItem: type: string description: The scheduling equivalent CPM item. nullable: true example: '' schedulingStart1: type: number description: The scheduling start1. format: decimal example: 1 schedulingDuration1: type: number description: The scheduling duration1. format: decimal example: 64 schedulingPercent1: type: number description: The scheduling percent1. format: decimal example: 100 schedulingStart2: type: number description: The schduling start1. format: decimal example: 0 schedulingDuration2: type: number description: The scheduling duration2. format: decimal example: 0 schedulingPercent2: type: number description: The scheduling percent2. format: decimal example: 0 schedulingStart3: type: number description: The scheduling start3. format: decimal example: 0 schedulingDuration3: type: number description: The scheduling duration3. format: decimal example: 0 schedulingPercent3: type: number description: The scheduling percent3. format: decimal example: 0 schedulingStart4: type: number description: The scheduling start4. format: decimal example: 0 schedulingDuration4: type: number description: The scheduling duration4. format: decimal example: 0 schedulingPercent4: type: number description: The scheduling percent4. format: decimal example: 0 schedulingCPMLag: type: number description: The scheduling CPM lag. format: decimal example: 0 schedulingBarOption: type: string description: The scheduling bar option. nullable: true example: '' schedulingSubNet: type: string description: The scheduling sub net. nullable: true example: '' schedulingBarLineNum: type: number description: The scheduling bar line number. format: decimal example: 0 schedulingCPMExportDescription: type: string description: The scheduling CPM export description. nullable: true example: '' schedulingCPMSequential: type: string description: The scheduling CPM sequential. nullable: true example: '' nonAdditive: type: string description: The skip cost. nullable: true example: '' saveNonAdditive: type: string description: The save skip cost. nullable: true example: '' ODataQueryOptionsOfActivityIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfActivityIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfActivityIntegrationDto' ETagOfActivityIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false ETag: allOf: - $ref: '#/components/schemas/DynamicObject' - type: object additionalProperties: false properties: Item: nullable: true IsWellFormed: type: boolean EntityType: type: string nullable: true IsAny: type: boolean IsIfNoneMatch: type: boolean ConcurrencyProperties: type: object nullable: true additionalProperties: {} DynamicObject: type: object additionalProperties: false ODataQueryOptions: type: object additionalProperties: false properties: request: nullable: true oneOf: - $ref: '#/components/schemas/HttpRequest' context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' rawValues: nullable: true oneOf: - $ref: '#/components/schemas/ODataRawQueryOptions' selectExpand: nullable: true oneOf: - $ref: '#/components/schemas/SelectExpandQueryOption' apply: nullable: true oneOf: - $ref: '#/components/schemas/ApplyQueryOption' compute: nullable: true oneOf: - $ref: '#/components/schemas/ComputeQueryOption' filter: nullable: true oneOf: - $ref: '#/components/schemas/FilterQueryOption' search: nullable: true oneOf: - $ref: '#/components/schemas/SearchQueryOption' orderBy: nullable: true oneOf: - $ref: '#/components/schemas/OrderByQueryOption' skip: nullable: true oneOf: - $ref: '#/components/schemas/SkipQueryOption' skipToken: nullable: true oneOf: - $ref: '#/components/schemas/SkipTokenQueryOption' top: nullable: true oneOf: - $ref: '#/components/schemas/TopQueryOption' count: nullable: true oneOf: - $ref: '#/components/schemas/CountQueryOption' validator: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryValidator' ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETag' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETag' HttpRequest: type: object x-abstract: true additionalProperties: false properties: bodyReader: $ref: '#/components/schemas/PipeReader' routeValues: $ref: '#/components/schemas/RouteValueDictionary' PipeReader: type: object x-abstract: true additionalProperties: false RouteValueDictionary: type: object additionalProperties: false properties: _arrayStorage: type: array items: $ref: '#/components/schemas/KeyValuePairOfStringAndObject' _propertyStorage: nullable: true oneOf: - $ref: '#/components/schemas/PropertyStorage' Item: nullable: true Comparer: $ref: '#/components/schemas/IEqualityComparerOfString' Count: type: integer format: int32 Keys: type: array items: type: string Values: type: array items: nullable: true KeyValuePairOfStringAndObject: type: object additionalProperties: false properties: key: type: string value: {} PropertyStorage: type: object additionalProperties: false properties: value: {} properties: type: array items: $ref: '#/components/schemas/PropertyHelper' PropertyHelper: type: object additionalProperties: false properties: property: $ref: '#/components/schemas/PropertyInfo' name: type: string valueGetter: $ref: '#/components/schemas/FuncOfObjectAndObject' valueSetter: $ref: '#/components/schemas/ActionOfObjectAndObject' PropertyInfo: allOf: - $ref: '#/components/schemas/MemberInfo' - type: object x-abstract: true additionalProperties: false properties: memberType: $ref: '#/components/schemas/MemberTypes' isSpecialName: type: boolean getMethod: nullable: true oneOf: - $ref: '#/components/schemas/MethodInfo' setMethod: nullable: true oneOf: - $ref: '#/components/schemas/MethodInfo' MemberTypes: type: integer description: '' x-enumFlags: true x-enumNames: - Constructor - Event - Field - Method - Property - TypeInfo - Custom - NestedType - All enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 - 191 MethodInfo: allOf: - $ref: '#/components/schemas/MethodBase' - type: object x-abstract: true additionalProperties: false properties: memberType: $ref: '#/components/schemas/MemberTypes' returnParameter: $ref: '#/components/schemas/ParameterInfo' returnType: type: string ParameterInfo: type: object additionalProperties: false properties: attributes: $ref: '#/components/schemas/ParameterAttributes' member: $ref: '#/components/schemas/MemberInfo' name: type: string nullable: true parameterType: type: string position: type: integer format: int32 isIn: type: boolean isLcid: type: boolean isOptional: type: boolean isOut: type: boolean isRetval: type: boolean defaultValue: nullable: true rawDefaultValue: nullable: true hasDefaultValue: type: boolean customAttributes: type: array items: $ref: '#/components/schemas/CustomAttributeData' metadataToken: type: integer format: int32 ParameterAttributes: type: integer description: '' x-enumFlags: true x-enumNames: - None - In - Out - Lcid - Retval - Optional - HasDefault - HasFieldMarshal - Reserved3 - Reserved4 - ReservedMask enum: - 0 - 1 - 2 - 4 - 8 - 16 - 4096 - 8192 - 16384 - 32768 - 61440 MemberInfo: type: object x-abstract: true additionalProperties: false properties: module: $ref: '#/components/schemas/Module' customAttributes: type: array items: $ref: '#/components/schemas/CustomAttributeData' isCollectible: type: boolean metadataToken: type: integer format: int32 Module: type: object x-abstract: true additionalProperties: false properties: assembly: $ref: '#/components/schemas/Assembly' fullyQualifiedName: type: string name: type: string mdStreamVersion: type: integer format: int32 moduleVersionId: type: string format: guid scopeName: type: string moduleHandle: $ref: '#/components/schemas/ModuleHandle' customAttributes: type: array items: $ref: '#/components/schemas/CustomAttributeData' metadataToken: type: integer format: int32 Assembly: type: object x-abstract: true additionalProperties: false properties: definedTypes: type: array items: type: string exportedTypes: type: array items: type: string codeBase: type: string nullable: true entryPoint: nullable: true oneOf: - $ref: '#/components/schemas/MethodInfo' fullName: type: string nullable: true imageRuntimeVersion: type: string isDynamic: type: boolean location: type: string reflectionOnly: type: boolean isCollectible: type: boolean isFullyTrusted: type: boolean customAttributes: type: array items: $ref: '#/components/schemas/CustomAttributeData' escapedCodeBase: type: string manifestModule: $ref: '#/components/schemas/Module' modules: type: array items: $ref: '#/components/schemas/Module' globalAssemblyCache: type: boolean deprecated: true x-deprecatedMessage: The Global Assembly Cache is not supported. hostContext: type: integer format: int64 securityRuleSet: $ref: '#/components/schemas/SecurityRuleSet' CustomAttributeData: type: object additionalProperties: false properties: attributeType: type: string constructor: allOf: - $ref: '#/components/schemas/MethodBase' - type: object x-abstract: true additionalProperties: false properties: memberType: $ref: '#/components/schemas/MemberTypes' constructorArguments: type: array items: $ref: '#/components/schemas/CustomAttributeTypedArgument' namedArguments: type: array items: $ref: '#/components/schemas/CustomAttributeNamedArgument' ConstructorInfo: allOf: - $ref: '#/components/schemas/MethodBase' - type: object x-abstract: true additionalProperties: false properties: memberType: $ref: '#/components/schemas/MemberTypes' MethodBase: allOf: - $ref: '#/components/schemas/MemberInfo' - type: object x-abstract: true additionalProperties: false properties: methodImplementationFlags: $ref: '#/components/schemas/MethodImplAttributes' callingConvention: $ref: '#/components/schemas/CallingConventions' isAbstract: type: boolean isConstructor: type: boolean isFinal: type: boolean isHideBySig: type: boolean isSpecialName: type: boolean isStatic: type: boolean isVirtual: type: boolean isAssembly: type: boolean isFamily: type: boolean isFamilyAndAssembly: type: boolean isFamilyOrAssembly: type: boolean isPrivate: type: boolean isPublic: type: boolean isConstructedGenericMethod: type: boolean isGenericMethod: type: boolean isGenericMethodDefinition: type: boolean containsGenericParameters: type: boolean isSecurityCritical: type: boolean isSecuritySafeCritical: type: boolean isSecurityTransparent: type: boolean MethodImplAttributes: type: integer description: '' x-enumNames: - IL - Managed - Native - OPTIL - Runtime - CodeTypeMask - Unmanaged - ManagedMask - NoInlining - ForwardRef - Synchronized - NoOptimization - PreserveSig - AggressiveInlining - AggressiveOptimization - InternalCall - MaxMethodImplVal enum: - 0 - 0 - 1 - 2 - 3 - 3 - 4 - 4 - 8 - 16 - 32 - 64 - 128 - 256 - 512 - 4096 - 65535 CallingConventions: type: integer description: '' x-enumFlags: true x-enumNames: - Standard - VarArgs - Any - HasThis - ExplicitThis enum: - 1 - 2 - 3 - 32 - 64 CustomAttributeTypedArgument: type: object additionalProperties: false properties: argumentType: type: string value: nullable: true CustomAttributeNamedArgument: type: object additionalProperties: false properties: memberInfo: $ref: '#/components/schemas/MemberInfo' typedValue: $ref: '#/components/schemas/CustomAttributeTypedArgument' memberName: type: string isField: type: boolean SecurityRuleSet: type: integer description: '' x-enumNames: - None - Level1 - Level2 enum: - 0 - 1 - 2 ModuleHandle: type: object additionalProperties: false properties: mdStreamVersion: type: integer format: int32 FuncOfObjectAndObject: allOf: - $ref: '#/components/schemas/MulticastDelegate' - type: object additionalProperties: false MulticastDelegate: allOf: - $ref: '#/components/schemas/Delegate' - type: object x-abstract: true additionalProperties: false Delegate: type: object x-abstract: true additionalProperties: false properties: target: nullable: true method: $ref: '#/components/schemas/MethodInfo' ActionOfObjectAndObject: allOf: - $ref: '#/components/schemas/MulticastDelegate' - type: object additionalProperties: false IEqualityComparerOfString: type: object x-abstract: true additionalProperties: false ODataQueryContext: type: object additionalProperties: false properties: defaultQuerySettings: nullable: true oneOf: - $ref: '#/components/schemas/DefaultQuerySettings' model: nullable: true oneOf: - $ref: '#/components/schemas/IEdmModel' elementType: nullable: true oneOf: - $ref: '#/components/schemas/IEdmType' navigationSource: nullable: true oneOf: - $ref: '#/components/schemas/IEdmNavigationSource' elementClrType: type: string nullable: true path: type: array nullable: true items: $ref: '#/components/schemas/ODataPathSegment' requestContainer: nullable: true oneOf: - $ref: '#/components/schemas/IServiceProvider' DefaultQuerySettings: type: object additionalProperties: false properties: enableExpand: type: boolean enableSelect: type: boolean enableCount: type: boolean enableOrderBy: type: boolean enableFilter: type: boolean maxTop: type: integer format: int32 nullable: true enableSkipToken: type: boolean IEdmModel: type: object x-abstract: true additionalProperties: false properties: schemaElements: type: array nullable: true items: $ref: '#/components/schemas/IEdmSchemaElement' vocabularyAnnotations: type: array nullable: true items: $ref: '#/components/schemas/IEdmVocabularyAnnotation' referencedModels: type: array nullable: true items: $ref: '#/components/schemas/IEdmModel' declaredNamespaces: type: array nullable: true items: type: string directValueAnnotationsManager: nullable: true oneOf: - $ref: '#/components/schemas/IEdmDirectValueAnnotationsManager' entityContainer: nullable: true oneOf: - $ref: '#/components/schemas/IEdmEntityContainer' IEdmSchemaElement: type: object x-abstract: true additionalProperties: false properties: schemaElementKind: $ref: '#/components/schemas/EdmSchemaElementKind' namespace: type: string nullable: true EdmSchemaElementKind: type: integer description: '' x-enumNames: - None - TypeDefinition - Term - Action - EntityContainer - Function enum: - 0 - 1 - 2 - 3 - 4 - 5 IEdmVocabularyAnnotation: type: object x-abstract: true additionalProperties: false properties: qualifier: type: string nullable: true term: nullable: true oneOf: - $ref: '#/components/schemas/IEdmTerm' target: nullable: true oneOf: - $ref: '#/components/schemas/IEdmVocabularyAnnotatable' value: nullable: true oneOf: - $ref: '#/components/schemas/IEdmExpression' IEdmTerm: type: object x-abstract: true additionalProperties: false properties: type: nullable: true oneOf: - $ref: '#/components/schemas/IEdmTypeReference' appliesTo: type: string nullable: true defaultValue: type: string nullable: true IEdmTypeReference: type: object x-abstract: true additionalProperties: false properties: isNullable: type: boolean definition: nullable: true oneOf: - $ref: '#/components/schemas/IEdmType' IEdmType: type: object x-abstract: true additionalProperties: false properties: typeKind: $ref: '#/components/schemas/EdmTypeKind' EdmTypeKind: type: integer description: '' x-enumNames: - None - Primitive - Entity - Complex - Collection - EntityReference - Enum - TypeDefinition - Untyped - Path enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 IEdmVocabularyAnnotatable: type: object x-abstract: true additionalProperties: false IEdmExpression: type: object x-abstract: true additionalProperties: false properties: expressionKind: $ref: '#/components/schemas/EdmExpressionKind' EdmExpressionKind: type: integer description: '' x-enumNames: - None - BinaryConstant - BooleanConstant - DateTimeOffsetConstant - DecimalConstant - FloatingConstant - GuidConstant - IntegerConstant - StringConstant - DurationConstant - 'Null' - Record - Collection - Path - If - Cast - IsType - FunctionApplication - LabeledExpressionReference - Labeled - PropertyPath - NavigationPropertyPath - DateConstant - TimeOfDayConstant - EnumMember - AnnotationPath enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 IEdmDirectValueAnnotationsManager: type: object x-abstract: true additionalProperties: false IEdmEntityContainer: type: object x-abstract: true additionalProperties: false properties: elements: type: array nullable: true items: $ref: '#/components/schemas/IEdmEntityContainerElement' IEdmEntityContainerElement: type: object x-abstract: true additionalProperties: false properties: containerElementKind: $ref: '#/components/schemas/EdmContainerElementKind' container: nullable: true oneOf: - $ref: '#/components/schemas/IEdmEntityContainer' EdmContainerElementKind: type: integer description: '' x-enumNames: - None - EntitySet - ActionImport - FunctionImport - Singleton enum: - 0 - 1 - 2 - 3 - 4 IEdmNavigationSource: type: object x-abstract: true additionalProperties: false properties: navigationPropertyBindings: type: array nullable: true items: $ref: '#/components/schemas/IEdmNavigationPropertyBinding' path: nullable: true oneOf: - $ref: '#/components/schemas/IEdmPathExpression' type: nullable: true oneOf: - $ref: '#/components/schemas/IEdmType' IEdmNavigationPropertyBinding: type: object x-abstract: true additionalProperties: false properties: navigationProperty: nullable: true oneOf: - $ref: '#/components/schemas/IEdmNavigationProperty' target: nullable: true oneOf: - $ref: '#/components/schemas/IEdmNavigationSource' path: nullable: true oneOf: - $ref: '#/components/schemas/IEdmPathExpression' IEdmNavigationProperty: type: object x-abstract: true additionalProperties: false properties: partner: nullable: true oneOf: - $ref: '#/components/schemas/IEdmNavigationProperty' onDelete: $ref: '#/components/schemas/EdmOnDeleteAction' containsTarget: type: boolean referentialConstraint: nullable: true oneOf: - $ref: '#/components/schemas/IEdmReferentialConstraint' EdmOnDeleteAction: type: integer description: '' x-enumNames: - None - Cascade enum: - 0 - 1 IEdmReferentialConstraint: type: object x-abstract: true additionalProperties: false properties: propertyPairs: type: array nullable: true items: $ref: '#/components/schemas/EdmReferentialConstraintPropertyPair' EdmReferentialConstraintPropertyPair: type: object additionalProperties: false properties: dependentProperty: nullable: true oneOf: - $ref: '#/components/schemas/IEdmStructuralProperty' principalProperty: nullable: true oneOf: - $ref: '#/components/schemas/IEdmStructuralProperty' IEdmStructuralProperty: type: object x-abstract: true additionalProperties: false properties: defaultValueString: type: string nullable: true IEdmPathExpression: type: object x-abstract: true additionalProperties: false properties: pathSegments: type: array nullable: true items: type: string path: type: string nullable: true ODataPathSegment: type: object x-abstract: true additionalProperties: false properties: identifier: type: string nullable: true IServiceProvider: type: object x-abstract: true additionalProperties: false ODataRawQueryOptions: type: object additionalProperties: false properties: filter: type: string nullable: true apply: type: string nullable: true compute: type: string nullable: true search: type: string nullable: true orderBy: type: string nullable: true top: type: string nullable: true skip: type: string nullable: true select: type: string nullable: true expand: type: string nullable: true count: type: string nullable: true format: type: string nullable: true skipToken: type: string nullable: true deltaToken: type: string nullable: true SelectExpandQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' rawSelect: type: string nullable: true rawExpand: type: string nullable: true compute: nullable: true oneOf: - $ref: '#/components/schemas/ComputeQueryOption' validator: nullable: true oneOf: - $ref: '#/components/schemas/SelectExpandQueryValidator' selectExpandClause: nullable: true oneOf: - $ref: '#/components/schemas/SelectExpandClause' levelsMaxLiteralExpansionDepth: type: integer format: int32 ComputeQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' resultClrType: type: string nullable: true computeClause: nullable: true oneOf: - $ref: '#/components/schemas/ComputeClause' rawValue: type: string nullable: true ComputeClause: type: object additionalProperties: false properties: computedItems: type: array nullable: true items: $ref: '#/components/schemas/ComputeExpression' ComputeExpression: type: object additionalProperties: false properties: expression: nullable: true oneOf: - $ref: '#/components/schemas/SingleValueNode' alias: type: string nullable: true typeReference: nullable: true oneOf: - $ref: '#/components/schemas/IEdmTypeReference' SingleValueNode: allOf: - $ref: '#/components/schemas/QueryNode' - type: object x-abstract: true additionalProperties: false properties: kind: $ref: '#/components/schemas/QueryNodeKind' QueryNodeKind: type: integer description: '' x-enumNames: - None - Constant - Convert - NonResourceRangeVariableReference - BinaryOperator - UnaryOperator - SingleValuePropertyAccess - CollectionPropertyAccess - SingleValueFunctionCall - Any - CollectionNavigationNode - SingleNavigationNode - SingleValueOpenPropertyAccess - SingleResourceCast - All - CollectionResourceCast - ResourceRangeVariableReference - SingleResourceFunctionCall - CollectionFunctionCall - CollectionResourceFunctionCall - NamedFunctionParameter - ParameterAlias - EntitySet - KeyLookup - SearchTerm - CollectionOpenPropertyAccess - CollectionComplexNode - SingleComplexNode - Count - SingleValueCast - CollectionPropertyNode - AggregatedCollectionPropertyNode - In - CollectionConstant enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 QueryNode: type: object x-abstract: true additionalProperties: false SelectExpandQueryValidator: type: object additionalProperties: false SelectExpandClause: type: object additionalProperties: false properties: selectedItems: type: array nullable: true items: $ref: '#/components/schemas/SelectItem' allSelected: type: boolean SelectItem: type: object x-abstract: true additionalProperties: false ApplyQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' resultClrType: type: string nullable: true applyClause: nullable: true oneOf: - $ref: '#/components/schemas/ApplyClause' rawValue: type: string nullable: true ApplyClause: type: object additionalProperties: false properties: transformations: type: array nullable: true items: $ref: '#/components/schemas/TransformationNode' TransformationNode: type: object x-abstract: true additionalProperties: false FilterQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' validator: nullable: true oneOf: - $ref: '#/components/schemas/FilterQueryValidator' compute: nullable: true oneOf: - $ref: '#/components/schemas/ComputeQueryOption' filterClause: nullable: true oneOf: - $ref: '#/components/schemas/FilterClause' rawValue: type: string nullable: true FilterQueryValidator: type: object additionalProperties: false FilterClause: type: object additionalProperties: false properties: expression: nullable: true oneOf: - $ref: '#/components/schemas/SingleValueNode' rangeVariable: nullable: true oneOf: - $ref: '#/components/schemas/RangeVariable' itemType: nullable: true oneOf: - $ref: '#/components/schemas/IEdmTypeReference' RangeVariable: type: object x-abstract: true additionalProperties: false SearchQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' resultClrType: type: string nullable: true searchClause: nullable: true oneOf: - $ref: '#/components/schemas/SearchClause' rawValue: type: string nullable: true SearchClause: type: object additionalProperties: false properties: expression: nullable: true oneOf: - $ref: '#/components/schemas/SingleValueNode' OrderByQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' orderByNodes: type: array nullable: true items: $ref: '#/components/schemas/OrderByNode' rawValue: type: string nullable: true validator: nullable: true oneOf: - $ref: '#/components/schemas/OrderByQueryValidator' compute: nullable: true oneOf: - $ref: '#/components/schemas/ComputeQueryOption' orderByClause: nullable: true oneOf: - $ref: '#/components/schemas/OrderByClause' OrderByNode: type: object x-abstract: true additionalProperties: false properties: direction: $ref: '#/components/schemas/OrderByDirection' OrderByDirection: type: integer description: '' x-enumNames: - Ascending - Descending enum: - 0 - 1 OrderByQueryValidator: type: object additionalProperties: false OrderByClause: type: object additionalProperties: false properties: thenBy: nullable: true oneOf: - $ref: '#/components/schemas/OrderByClause' expression: nullable: true oneOf: - $ref: '#/components/schemas/SingleValueNode' direction: $ref: '#/components/schemas/OrderByDirection' rangeVariable: nullable: true oneOf: - $ref: '#/components/schemas/RangeVariable' itemType: nullable: true oneOf: - $ref: '#/components/schemas/IEdmTypeReference' SkipQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' rawValue: type: string nullable: true value: type: integer format: int32 validator: nullable: true oneOf: - $ref: '#/components/schemas/SkipQueryValidator' SkipQueryValidator: type: object additionalProperties: false SkipTokenQueryOption: type: object additionalProperties: false properties: rawValue: type: string nullable: true context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' validator: nullable: true oneOf: - $ref: '#/components/schemas/SkipTokenQueryValidator' handler: nullable: true oneOf: - $ref: '#/components/schemas/SkipTokenHandler' SkipTokenQueryValidator: type: object additionalProperties: false SkipTokenHandler: type: object x-abstract: true additionalProperties: false TopQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' rawValue: type: string nullable: true value: type: integer format: int32 validator: nullable: true oneOf: - $ref: '#/components/schemas/TopQueryValidator' TopQueryValidator: type: object additionalProperties: false CountQueryOption: type: object additionalProperties: false properties: context: nullable: true oneOf: - $ref: '#/components/schemas/ODataQueryContext' rawValue: type: string nullable: true value: type: boolean validator: nullable: true oneOf: - $ref: '#/components/schemas/CountQueryValidator' CountQueryValidator: type: object additionalProperties: false ODataQueryValidator: type: object additionalProperties: false IntegrationResponseSingleOfActivityIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/ActivityIntegrationDto' IntegrationResponseOfActivityCodebookIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/ActivityCodebookIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 ActivityCodebookIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique activity codebook id. format: guid example: 8D3BC1EB-4105-4DA6-86B9-6D079D40DC7E systemBackupId: type: string description: The unique system backup id that this record came from. format: guid example: 773EB7D8-FE28-4FC5-BA0A-2560595551A9 activityCode: type: string description: The activity code. nullable: true example: '805124' description: type: string description: The activity description nullable: true example: 24" C.S.Floor Stand categoryLevel: type: string description: The codebook level nullable: true example: '5' units: type: string description: The activity units nullable: true example: EA lastUpdate: type: string description: Last save date of the record format: date-time nullable: true example: '2022-02-10T03:09:48Z' lastUpdateUser: type: number description: Last user to modify the record format: decimal example: 491491 alternateDescription: type: string description: Alternate description for reports and misc stuff nullable: true example: '' alternateCode: type: string description: Activity alternate code nullable: true example: '' marineLand: type: string description: Checkbox for if this is a marine activity nullable: true example: L factorable: type: string description: Corresponds to Activity.Factorable. Default value is "Y" nullable: true example: 'Y' summaryCode: type: string description: Summary code for this item that will be pulled into the Activity summary code field nullable: true example: '' useBiditemDescription: type: string description: Flag to use biditem description when creating activity from codebook nullable: true example: 'N' use1ForLs: type: string description: Default Lumpsum (LS) Quantity to 1 nullable: true example: 'Y' notes: type: string description: The activity notes nullable: true example: '' spreadsheetCalcPath: type: string description: Holds the relative path for a spreadsheet calculation that will be pulled in whenever an activity is pulled in from the codebook nullable: true example: CustomCalculation\Calc.hbcs crew: type: string description: Default crew code to be used for this activity nullable: true example: AMLML calendar: type: string description: Calendar to be used for this activity instead of the estimate default nullable: true example: '512' defaultProdType: type: string description: The default production type for this activity nullable: true example: MU defaultProdRate: type: number description: The default production rate for this activity format: decimal example: 0 workersCompCode: type: string description: Workers comp code to be used for this activity instead of the estimate default nullable: true example: '5213' bidConversionFactor: type: number description: 'Factor to the biditem quantity the activity is being pulled into. ' format: decimal example: 0 pullResources: type: string description: 'This is the checkbox for "Automatically pull in resource codes" ' nullable: true example: 'Y' allowInEstimate: type: string description: Specify whether that Activity in the Activity Cookbook can be pulled into an estimate. Valid value - "Y"/"N" nullable: true example: 'Y' hjCode: type: string description: Activity HeavyJob Code nullable: true example: '' heavyJobDescription: type: string description: Alternate description to be used in heavyjob nullable: true example: '' userFlag1: type: string description: User Defined Checkbox 1 nullable: true example: 'N' userFlag2: type: string description: User Defined Checkbox 2 nullable: true example: 'N' reportGroup1: type: string description: The activity report group 1. This field is like a biditem summary group but for activities. nullable: true example: '' reportGroup2: type: string description: The activity report group 2. This field is like a biditem summary group but for activities. nullable: true example: '' reportGroup3: type: string description: The activity report group 3. This field is like a biditem summary group but for activities. nullable: true example: '' reportGroup4: type: string description: The activity report group 4. This field is like a biditem summary group but for activities. nullable: true example: '' reportGroup5: type: string description: The activity report group 5. This field is like a biditem summary group but for activities. nullable: true example: '' reportGroup6: type: string description: The activity report group 6. This field is like a biditem summary group but for activities. nullable: true example: '' ODataQueryOptionsOfActivityCodebookIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfActivityCodebookIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfActivityCodebookIntegrationDto' ETagOfActivityCodebookIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false IntegrationResponseSingleOfActivityCodebookIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/ActivityCodebookIntegrationDto' IntegrationResponseOfActivityCodebookResourceIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/ActivityCodebookResourceIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 ActivityCodebookResourceIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique activity codebook resource id. format: guid example: 16D39CAD-3FEE-4498-8861-3C0ABD285819 activityCodebookId: type: string description: The activity codebook record this is linked to format: guid example: 8D3BC1EB-4105-4DA6-86B9-6D079D40DC7E activityCodebookCode: type: string description: The linked activity codebook code. nullable: true example: '805124' resourceCode: type: string description: Resource code to be added to the activity outside the crew when pulling in the activity nullable: true example: 2Q05124 unitPrice: type: number description: Override unit price of the resource. Leaving this zero pulls in the default from the local or systemwide material format: decimal example: 0 units: type: string description: Unit of measure nullable: true example: LF quantityFactor: type: number description: The factor of the activity quantity to use for the resource quantity. If the activity quantity is 100 and the codedetl.conv is 2, then the resource will use 200 for the quantity format: decimal example: 1 wasteFactor: type: number description: |- waste factor for the resource. This is the percentage(10% = 1.10) factor the calculated resource quantity will be multiplied by to create the actual resource quantity used. Example: If you have 500 tons of bedding material with a 5% (1.05) waste factor, the actual resource quantity used will be 525 tons. format: decimal example: 1 mhPerUnit: type: number description: |- This is the percentage (10% = 1.10) factor the calculated resource quantity will be multiplied by to create the actual resource quantity used. Example: If you have 500 tons of bedding material with a 5% (1.05) waste factor, the actual resource quantity used will be 525 tons. format: decimal example: 0 ODataQueryOptionsOfActivityCodebookResourceIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfActivityCodebookResourceIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfActivityCodebookResourceIntegrationDto' ETagOfActivityCodebookResourceIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false IntegrationResponseSingleOfActivityCodebookResourceIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/ActivityCodebookResourceIntegrationDto' IntegrationResponseOfAttachmentIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/AttachmentIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 AttachmentIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique attachment id. format: guid example: a29ec892-1e4b-4116-89f4-7dd84350a5b5 fileName: type: string description: The name of the file. nullable: true example: plans.pdf File: type: object x-abstract: true additionalProperties: false IntegrationResponseOfBiditemCodebookIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/BiditemCodebookIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 BiditemCodebookIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique biditem codebook id. format: guid example: D426AA0A-8647-4E46-946B-690848A6D6CE systemBackupId: type: string description: The unique system backup id that this record came from. format: guid example: BA838DC9-8B4C-4D51-8AEE-7C9339FEA4BB state: type: string description: This is the entity (usually state, but can be area, municipal, or private codebook nullable: true example: FL biditemCode: type: string description: Code unique for the bidmast.state code nullable: true example: 0100 70 description: type: string description: Description of the item nullable: true example: OVERLAY DEMONSTRATION units: type: string description: Unit of measure nullable: true example: LS categoryLevel: type: string description: The codebook level nullable: true example: '0' lowUnitPrice: type: number description: Low price for this biditem that is bid. Usually this is from bid history or from an import of biditem codes from the state format: decimal example: 0 averageUnitPrice: type: number description: |- Average price for this biditem that is bid. This is from bid history or from an import of biditem codes from the state. However, it can be an internal price as well. This will be imported into the estimate on importing and merging from biditem codebook if pull in average price is used. The user can then print a bid proposal without doing anything to get a feel for the price of the job to see if they want to bid on the proposal or use the total to give to a bonding company format: decimal example: 0 highUnitPrice: type: number description: High price for this biditem that is bid. Usually this is from bid history or from an import of biditem codes from the state format: decimal example: 0 lock: type: string description: '"Lock" the prices of a record - meaning Bid History cannot compute an average and overwrite the prices in the record' nullable: true example: 'N' libraryBiditem: type: string description: Biditem to pull from the library estimate when merging data from biditem codebook nullable: true example: '' linkedResource: type: string description: Code of the resource to pull in when merging from biditem codebook. This is usually a subcontract code nullable: true example: '' summarySortCode1: type: string description: Summary sort to pull into biditem when used in an estimate. It will be put into summary sort 1 nullable: true example: '' summarySortCode2: type: string description: Summary sort to pull into biditem when used in an estimate. It will be put into summary sort 2. nullable: true example: '' summarySortCode3: type: string description: Summary sort to pull into biditem when used in an estimate. It will be put into summary sort 3. nullable: true example: '' summarySortCode4: type: string description: Summary sort to pull into biditem when used in an estimate. It will be put into summary sort 4. nullable: true example: '' summarySortCode5: type: string description: Summary sort to pull into biditem when used in an estimate. It will be put into summary sort 5. nullable: true example: '' summarySortCode6: type: string description: Summary sort to pull into biditem when used in an estimate. It will be put into summary sort 6. nullable: true example: '' linkedActivity1: type: string description: Activity from the activity codebook to pull into this biditem when pull in details from codebook used nullable: true example: '' linkedActivity2: type: string description: Activity from the activity codebook to pull into this biditem when pull in details from codebook used nullable: true example: '' linkedActivity3: type: string description: Activity from the activity codebook to pull into this biditem when pull in details from codebook used nullable: true example: '' linkedActivity4: type: string description: Activity from the activity codebook to pull into this biditem when pull in details from codebook used nullable: true example: '' linkedActivity5: type: string description: Activity from the activity codebook to pull into this biditem when pull in details from codebook used nullable: true example: '' equivalentBid: type: string description: |- allowing records to be linked. For instance, a state could have 10 different Clear and Grub items, but the customer may want them all to be brought in the same. In that case, the user will setup one item to how it should be brought in, then the other items would each choose the first item as their Equivalent Biditem. This is mainly intended to make it easier to make multiple biditem codebook states, especially for use in private work.A user only needs to keep one up-to-date, while the others are simply linked. nullable: true example: FL 0101 1 alternateDescription: type: string description: Alternate long description of the biditem. it is 255 characters and usually used for DOT reports nullable: true example: '' passThrough: type: string description: if the biditem is a pass-through item (which is assigned a price, and can have costs, but which is not marked up, does not generate markup, and has no addons/bond). nullable: true example: 'N' lastUpdate: type: string description: Last date of change for this record format: date-time nullable: true example: '2022-02-10T03:09:48Z' rsMeansAssembly: type: string description: RSMeans Assembly code that is associated with the Biditem inside Biditem Codebook nullable: true example: A10101051500 taxable: type: string description: Use the sales tax to take the biditem total price. It only appears on the Customized Bid Proposal. nullable: true example: 'Y' salesTax: type: number description: |- Enter the tax percentage for the biditem. The tax is applied to the total price of the biditem. Important: The sales tax will only be applied if the check box in the Taxable column is also selected, and only appears on the Customized Bid Proposal. format: decimal example: 10 spreadSheetAssembly: type: string description: Holds the relative path to a spreadsheet assembly that will be pulled in whenever a biditem is pulled from the codebook nullable: true example: Assembly\Assembly.hbcs ODataQueryOptionsOfBiditemCodebookIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfBiditemCodebookIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfBiditemCodebookIntegrationDto' ETagOfBiditemCodebookIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false IntegrationResponseSingleOfBiditemCodebookIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/BiditemCodebookIntegrationDto' IntegrationResponseOfBiditemIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/BiditemIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 BiditemIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique biditem id. format: guid example: db7284b1-b1d2-4eb3-9361-dfc88aa36bab estimateId: type: string description: The unique estimate id. format: guid example: 483e8356-7c9d-4949-b882-154072a8e38a estimateCode: type: string description: The HeavyBid estimate code. nullable: true example: 1-BRIDGE lastModified: type: string description: The last modified date. format: date-time example: '2022-02-10T03:09:48Z' biditemCode: type: string description: Biditem code, padded with spaces on the left for sorting. nullable: true example: 140 description: type: string description: The description. nullable: true example: Erosion Control type: type: string description: The type. nullable: true example: D quantity: type: number description: The takeoff quantity - this is what costs inside of HeavyBid are based on, not what is submitted to the owner format: decimal example: 1 bidQuantity: type: number description: Bid Quantity - this is the quantity that will be priced and given to the owner when the bid is submitted format: decimal example: 1 units: type: string description: The unit of meaure. nullable: true example: LS clientNumber: type: string description: Client number or owner's number that sometimes is used for bid forms instead of biditem number. nullable: true example: 1006002 subtotalLevel: type: string description: The subtotal level. nullable: true example: '' otherOptions: type: string description: Print options for reports (print non-adds, header and footer, etc.) set in biditem setup > bid report tab. nullable: true example: '' wbsCode: type: string description: The WBS code. nullable: true example: '' passThrough: type: string description: A flag to represent if the biditem is a passthrough item. nullable: true example: 'N' marineLand: type: string description: A flag to represent if the biditem is marine / land. nullable: true example: L parent: type: string description: The parent biditem code. nullable: true example: '' subDivided: type: string description: A flag to represent if the biditem is subdivided. nullable: true example: 'N' alternateUnits: type: string description: Longer alternate unit of measure for reports. nullable: true example: '' alternateDescription: type: string description: |- Alternate biditem description used for reporting purposes. Mainly for proposals that require longer descriptions than the Heavy­Bid default. nullable: true example: '' lowBid: type: number description: Low bid price, usually from bid history, from previous bidding done on this biditem from various sources. format: decimal example: 0 averageBid: type: number description: |- Average bid price, usually from bid history, from previous bidding done on this biditem from various sources. This number can be used for a quick idea of the total biditem cost. When totaled with other biditems can give a quick number to be used for bonding purposes without having to work up the estimate. format: decimal example: 0 highBid: type: number description: High bid price, usually from bid history, from previous bidding done on this biditem from various sources. format: decimal example: 0 stateCode: type: string description: State code from biditem codebook pulled in when adding a biditem from the biditem code book. Used for getting bid history pricing. nullable: true example: TX unitCostHoldingAccount: type: string description: The unit cost holding account. nullable: true example: '' taxPercent: type: number description: The tax percent. format: decimal example: 0 taxable: type: string description: A flag representing if the biditem is taxable. nullable: true example: 'N' bidPrice: type: number description: Price of the biditem to be bid. Extended by the bid quantity for the total. format: decimal example: 172034.8 summaryGroup1: type: string description: The summary group1. nullable: true example: '' summaryGroup2: type: string description: The summary group2. nullable: true example: '' summaryGroup3: type: string description: The summary group3. nullable: true example: '' summaryGroup4: type: string description: The summary group4. nullable: true example: '' summaryGroup5: type: string description: The summary group5. nullable: true example: '' summaryGroup6: type: string description: The summary group6. nullable: true example: '' reviewFlag: type: string description: A flag representing if the biditem has been reviewed. nullable: true example: 'N' estInitials: type: string description: The estimator initials. nullable: true example: PRM sortCode: type: string description: The biditem sort code. nullable: true example: 140 costNotes: type: string description: The cost notes. nullable: true example: '' bidNotes: type: string description: The bid notes. nullable: true example: '' factor: type: number description: The factor. format: decimal example: 1 schedulingStart1: type: number description: The scheduling start1. format: decimal example: 1 schedulingDuration1: type: number description: The scheduling duration1. format: decimal example: 64 schedulingPercent1: type: number description: The scheduling percent1. format: decimal example: 100 schedulingStart2: type: number description: The scheduling start2. format: decimal example: 0 schedulingDuration2: type: number description: The scheduling duration2. format: decimal example: 0 schedulingPercent2: type: number description: The scheduling percent2. format: decimal example: 0 schedulingStart3: type: number description: The scheduling start3. format: decimal example: 0 schedulingDuration3: type: number description: The scheduling duration3. format: decimal example: 0 schedulingPercent3: type: number description: The scheduling percent3. format: decimal example: 0 schedulingStart4: type: number description: The scheduling start4. format: decimal example: 0 schedulingDuration4: type: number description: The scheduling duration4. format: decimal example: 0 schedulingPercent4: type: number description: The scheduling percent4. format: decimal example: 0 biditemPercentValue: type: number description: The bid item percent value. format: decimal example: 0 pricingStatus: type: string description: The pricing status. nullable: true example: '' userActivity1: type: number description: The total user activity quantity 1. format: decimal example: 0 userActivity2: type: number description: The total user activity quantity 2. format: decimal example: 0 userActivity3: type: number description: The total user activity quantity 3. format: decimal example: 0 userActivity4: type: number description: The total user activity quantity 4. format: decimal example: 0 labor: type: number description: The total labor. format: decimal example: 41328 burden: type: number description: The total burden. format: decimal example: 13176.48 permanentMaterial: type: number description: The total permanent material. format: decimal example: 73500 constructionMaterial: type: number description: The total construction material. format: decimal example: 0 subcontract: type: number description: The total subcontract. format: decimal example: 0 equipmentOperatingExpense: type: number description: The total equipment operating expense. format: decimal example: 2209.16 companyEquipment: type: number description: The total company equipment. format: decimal example: 6126.44 rentedEquipment: type: number description: The total rented equipment. format: decimal example: 0 misc1: type: number description: The total Misc1. format: decimal example: 0 misc2: type: number description: The total Misc2. format: decimal example: 0 misc3: type: number description: The total Misc3. format: decimal example: 0 directTotal: type: number description: The direct total. format: decimal example: 136340.08 equipmentAccountDollars: type: number description: The total equipment account dollars. format: decimal example: 0 indirectTotal: type: number description: The indirect total. format: decimal example: 15802.65 addonBond: type: number description: The addon bond total. format: decimal example: 5134.43 totalCost: type: number description: The total cost. format: decimal example: 157277.16 totalCostAdjToBidQuantity: type: number description: The total cost adjustment to bid quantity. format: decimal example: 157277.16 markup: type: number description: The markup. format: decimal example: 14757.64 totalTakeoff: type: number description: The total takeoff. format: decimal example: 172034.8 totalBalanced: type: number description: The total balanced. format: decimal example: 172034.8 manhours: type: number description: The man-hours. format: decimal example: 3080 escalationTotalCost: type: number description: The escalation total cost. format: decimal example: 0 fixedCost: type: number description: The fixed cost. format: decimal example: 0 freezeBid: type: string description: A flag representing if the biditem is frozen for pricing purposes. nullable: true example: '' sequenceItemNumber: type: number description: The sequence item number. format: decimal example: 5 holdingAccountActivityQuantity: type: number description: The holding account activity quantity. format: decimal example: 0 accountingRevenueCode: type: string description: The account revenue code. nullable: true example: 140 schedulingCPMCode: type: string description: Scheduling Critical Path Method Code (CPM) assigns a code to each Biditem for export to another scheduling system. nullable: true example: '' schedulingCPMOverlap: type: number description: The number of days between the start of this Biditem and the end of this items Predecessor biditem. format: decimal example: 0 schedulingCalc_Days: type: number description: The scheduling calculated days. format: decimal example: 45 folder: type: string description: The folder. nullable: true example: '' singleAlternate: type: string description: The single alternate. nullable: true example: 'N' packageAlternate: type: string description: The package alternate. nullable: true example: '' userFlag1: type: string description: The user flag1. nullable: true example: 'N' userFlag2: type: string description: The user flag2. nullable: true example: 'Y' childBidPrice: type: number description: The child bid price. format: decimal example: 0 zeroPriceText: type: string description: A note field for the users to write notes about why this Biditem has 0 price. nullable: true example: '' unitCostItem: type: string description: The unit cost item. nullable: true example: '' ODataQueryOptionsOfBiditemIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfBiditemIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfBiditemIntegrationDto' ETagOfBiditemIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false IntegrationResponseSingleOfBiditemIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/BiditemIntegrationDto' IntegrationResponseOfApiBusinessUnitRead: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/ApiBusinessUnitRead' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 ApiBusinessUnitRead: type: object additionalProperties: false required: - id properties: id: type: string description: The setups business unit id. format: guid minLength: 1 example: b63bbfcf-8598-43f5-9e5a-90cd6255d071 division: type: string description: The heavybid division code. nullable: true example: MANAGER businessUnitCode: type: string description: The setups business unit code. nullable: true example: MANAGER partitionId: type: string description: The HeavyBid partition Id. format: guid example: c7gbfcf-8598-43f5-9e5a-90cd6255d071 systemInfoId: type: string description: The HeavyBid System Id. format: guid example: a54bbfcf-8598-43f5-9e5a-90cd6255d071 IntegrationResponseOfEstimateIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/EstimateIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 EstimateIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The estimate id. format: guid example: 483e8356-7c9d-4949-b882-154072a8e38a partitionId: type: string description: The partition id. format: guid example: 4621c8dd-c771-4690-9c01-39534ad9940d businessUnitId: type: string description: The business unit id. format: guid example: b63bbfcf-8598-43f5-9e5a-90cd6255d071 businessUnitCode: type: string description: The business unit code. nullable: true example: MANAGER heavyBidDivision: type: string description: The HeavyBid division. nullable: true example: MANAGER code: type: string description: The estimate code. nullable: true example: 1-BRIDGE name: type: string description: The name. nullable: true example: Sugarland Bridge Project processedStatus: description: |- The processed status of the estimate. 0 = queued 1 = processing 2 = success 3 = failure example: 2 oneOf: - $ref: '#/components/schemas/StatusCode' description: type: string description: The description. nullable: true example: Sugarland Bridge Project estimateVersion: type: string description: The estimate version. nullable: true example: 2022 filters: description: The filters. nullable: true oneOf: - $ref: '#/components/schemas/EstimateFiltersIntegrationDto' totals: description: The estimate totals. nullable: true oneOf: - $ref: '#/components/schemas/EstimateTotals' lastModified: type: string description: The last modified date. format: date-time example: '2021-05-04T17:29:44Z' lastProcessed: type: string description: The last processed date. format: date-time nullable: true example: '2021-05-04T17:29:44Z' isExcludedEstimate: type: boolean description: Whether the estimate is excluded. example: false isActiveEstimate: type: boolean description: Whether the estimate is active. example: true isDeleted: type: boolean description: Whether the estimate is deleted. example: false deletedTimestamp: type: string description: The deleted date. format: date-time nullable: true example: null notes: description: The estimate notes. nullable: true oneOf: - $ref: '#/components/schemas/EstimateNotes' StatusCode: type: integer description: '' x-enumNames: - Queued - Processing - Success - Failure - QueuedLarge - TooLarge - NoProcess enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 EstimateFiltersIntegrationDto: type: object additionalProperties: false properties: projectName: type: string description: The project name for the estimate. Can be assigned and viewed on the estimate management view. nullable: true example: Bridge Improvements projectNumber: type: string description: The project code for the estimate. Can be assigned and viewed on the estimate management view. nullable: true example: 0917-30-057 status: type: string description: A user defined estimate status filter. nullable: true example: BIDDING engineer: type: string description: The engineering firm responsible for designing the project, including plans, bid documents, and contract documents. nullable: true example: ELI estimator: type: string nullable: true example: PRM owner: type: string description: The owner to whom the bid is submitted. nullable: true example: TXDOT bidDate: type: string description: The date the bid is due. format: date-time nullable: true example: '2022-10-23T00:00:00Z' startDate: type: string description: The expected start date for the estimate. format: date-time nullable: true example: '2022-11-23T00:00:00Z' reviewDate: type: string description: The date for internally reviewing the bid. format: date-time nullable: true example: '2022-10-15T00:00:00Z' createdDate: type: string description: The date the estimate was created. format: date-time nullable: true example: '2022-05-23T00:00:00Z' modifiedDate: type: string description: The estimate last modified date. format: date-time nullable: true example: '2022-06-23T00:00:00Z' modifiedTime: type: number description: The time element of the date/time that this estimate was last modified. format: double nullable: true example: 1426 state: type: string description: The time element of the date/time that this estimate was last modified. nullable: true example: Workers Comp State typeOfWork: type: string description: Type of work nullable: true example: BRIDGE estimateTag1: type: string description: Estimate Tag 1. Used for filtering. nullable: true example: BRIDGE estimateTag2: type: string description: Estimate Tag 2. Used for filtering. nullable: true example: FT BEND estimateTag3: type: string description: Estimate Tag 3. Used for filtering. nullable: true example: '' estimateTag4: type: string description: Estimate Tag 4. Used for filtering. nullable: true example: '' estimateTag5: type: string description: Estimate Tag 5. Used for filtering. nullable: true example: '' estimateTag6: type: string description: Estimate Tag 6. Used for filtering. nullable: true example: '' userDefinedText1: type: string description: User-defined ascii value 1. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText2: type: string description: User-defined ascii value 2. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText3: type: string description: User-defined ascii value 3. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText4: type: string description: User-defined ascii value 4. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText5: type: string description: User-defined ascii value 5. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText6: type: string description: User-defined ascii value 6. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText7: type: string description: User-defined ascii value 7. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText8: type: string description: User-defined ascii value 8. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText9: type: string description: User-defined ascii value 9. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText10: type: string description: User-defined ascii value 10. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText11: type: string description: User-defined ascii value 11. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText12: type: string description: User-defined ascii value 12. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText13: type: string description: User-defined ascii value 13. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText14: type: string description: User-defined ascii value 14. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText15: type: string description: User-defined ascii value 15. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText16: type: string description: User-defined ascii value 16. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText17: type: string description: User-defined ascii value 17. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText18: type: string description: User-defined ascii value 18. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText19: type: string description: User-defined ascii value 19. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedText20: type: string description: User-defined ascii value 20. Can be assigned and used as a filter on the estimate management view. nullable: true example: '' userDefinedInteger1: type: integer description: User-defined integer value 1. Can be assigned and used as a filter on the estimate management view. format: int64 nullable: true userDefinedInteger2: type: integer description: User-defined integer value 2. Can be assigned and used as a filter on the estimate management view. format: int64 nullable: true userDefinedInteger3: type: integer description: User-defined integer value 3. Can be assigned and used as a filter on the estimate management view. format: int64 nullable: true userDefinedInteger4: type: integer description: User-defined integer value 4. Can be assigned and used as a filter on the estimate management view. format: int64 nullable: true userDefinedInteger5: type: integer description: User-defined integer value 5. Can be assigned and used as a filter on the estimate management view. format: int64 nullable: true userDefinedNumber1: type: number description: User-defined number 1 format: double nullable: true userDefinedNumber2: type: number description: User-defined number 2 format: double nullable: true userDefinedNumber3: type: number description: User-defined number 3 format: double nullable: true userDefinedNumber4: type: number description: User-defined number 4 format: double nullable: true userDefinedNumber5: type: number description: User-defined number 5 format: double nullable: true userDefinedNumber6: type: number description: User-defined number 6 format: double nullable: true userDefinedNumber7: type: number description: User-defined number 7 format: double nullable: true userDefinedNumber8: type: number description: User-defined number 8 format: double nullable: true userDefinedNumber9: type: number description: User-defined number 9 format: double nullable: true userDefinedNumber10: type: number description: User-defined number 10 format: double nullable: true userDefinedNumber11: type: number description: User-defined number 11 format: double nullable: true userDefinedNumber12: type: number description: User-defined number 12 format: double nullable: true userDefinedNumber13: type: number description: User-defined number 13 format: double nullable: true userDefinedNumber14: type: number description: User-defined number 14 format: double nullable: true userDefinedNumber15: type: number description: User-defined number 15 format: double nullable: true userDefinedNumber16: type: number description: User-defined number 16 format: double nullable: true userDefinedNumber17: type: number description: User-defined number 17 format: double nullable: true userDefinedNumber18: type: number description: User-defined number 18 format: double nullable: true userDefinedNumber19: type: number description: User-defined number 19 format: double nullable: true userDefinedNumber20: type: number description: User-defined number 20 format: double nullable: true userDefinedDate1: type: string description: User-defined date format: date-time nullable: true userDefinedDate2: type: string description: User-defined date format: date-time nullable: true userDefinedDate3: type: string description: User-defined date format: date-time nullable: true userDefinedDate4: type: string description: User-defined date format: date-time nullable: true userDefinedDate5: type: string description: User-defined date format: date-time nullable: true address: type: string description: Address of estimate nullable: true example: 18427 Southwest Fwy, Sugar Land, TX 77479 latitude: type: number description: Latitude of location format: double nullable: true example: 29.57095798694368 longitude: type: number description: Longitude of location format: double nullable: true example: -95.66260564233129 addendumNumber: type: string description: The addendum number of the estimate. nullable: true example: 1 EstimateTotals: type: object additionalProperties: false properties: baseLabor_Direct: type: number description: Direct base labor format: double example: 1572160.52 baseLabor_Indirect: type: number description: Indirect base labor format: double example: 706640 baseLabor_Total: type: number description: Total base labor format: double example: 2278800.52 burden_Direct: type: number description: Direct burden format: double example: 565985.7 burden_Indirect: type: number description: Indirect burden format: double example: 193723.56 burden_Total: type: number description: Total burden format: double example: 759709.26 totalLabor_Direct: type: number description: Direct base labor + direct burden format: double example: 2138146.22 totalLabor_Indirect: type: number description: Indirect base labor + indirect burden format: double example: 900363.56 totalLabor_Total: type: number description: Total base labor + total burden format: double example: 3038509.78 permanentMaterial_Direct: type: number description: Direct permanent material format: double example: 10809813 permanentMaterial_Indirect: type: number description: Indirect permanent material format: double example: 0 permanentMaterial_Total: type: number description: Total permanent material format: double example: 10809813 constructionMaterial_Direct: type: number description: Direct construction material format: double example: 629756.38 constructionMaterial_Indirect: type: number description: Indirect construction material format: double example: 505440.97 constructionMaterial_Total: type: number description: Total construction material format: double example: 1135197.35 subcontract_Direct: type: number description: Direct subcontract format: double example: 2400348.86 subcontract_Indirect: type: number description: Indirect subcontract format: double example: 90000 subcontract_Total: type: number description: Total subcontract format: double example: 2490348.86 equipmentOperatingExpense_Direct: type: number description: Direct equipment operating expense format: double example: 165571.5 equipmentOperatingExpense_Indirect: type: number description: Indirect equipment operating expense format: double example: 69523.99 equipmentOperatingExpense_Total: type: number description: Total equipment operating expense format: double example: 235095.49 companyEquipment_Direct: type: number description: Direct owned equipment format: double example: 1191362.07 companyEquipment_Indirect: type: number description: Indirect owned equipment format: double example: 146688.01 companyEquipment_Total: type: number description: Total owned equipment format: double example: 1338050.08 rentedEquipment_Direct: type: number description: Direct rented equipment format: double example: 1616.51 rentedEquipment_Indirect: type: number description: Indirect rented equipment format: double example: 0 rentedEquipment_Total: type: number description: Total rented equipment format: double example: 1616.51 misc1_Direct: type: number description: Direct misc 1 format: double example: 9450 misc1_Indirect: type: number description: Indirect misc 1 format: double example: 0 misc1_Total: type: number description: Total misc 1 format: double example: 9450 misc2_Direct: type: number description: Direct misc 2 format: double example: 0 misc2_Indirect: type: number description: Indirect misc 2 format: double example: 0 misc2_Total: type: number description: Total misc 2 format: double example: 0 misc3_Direct: type: number description: Direct misc 3 format: double example: 0 misc3_Indirect: type: number description: Indirect misc 3 format: double example: 0 misc3_Total: type: number description: Total misc 3 format: double example: 0 totalEntryCost_Takeoff_Direct: type: number description: Direct cost (takeoff) before addon and bond format: double example: 17346064.54 totalEntryCost_Takeoff_Indirect: type: number description: Indirect cost (takeoff) before addon and bond format: double example: 1712016.53 totalEntryCost_Takeoff_Total: type: number description: Total cost (takeoff) before addon and bond format: double example: 19058081.07 totalEntryCost_Bid_Direct: type: number description: Direct cost (bid) before addon and bond format: double example: 17346064.54 totalEntryCost_Bid_Indirect: type: number description: Indirect cost (bid) before addon and bond format: double example: 1712016.53 totalEntryCost_Bid_Total: type: number description: Total cost (bid) before addon and bond format: double example: 19058081.07 balMarkup_Bid: type: number description: Markup on balanced total (bid) format: double example: 1327053.97 actualMarkup_Bid: type: number description: Actual markup on total (bid) format: double example: 1327087.18 balancedBid_Bid: type: number description: Balanced bid total (bid) format: double example: 20941385.53 bidTotal_Bid: type: number description: Bid total (bid) format: double example: 20941418.74 addonBondTotal: type: number description: Total addon (markup + cost) format: double example: 556250.49 totalEqp_Direct: type: number description: Direct owned equipment + direct rented Equipment + direct equipment operating expense format: double example: 1358550.08 totalEqp_Indirect: type: number description: Indirect owned equipment + indirect Rented equipment + indirect equipment operating expense format: double example: 216212 totalEqp_Total: type: number description: Total owned equipment + total rented Equipment + total equipment operating expense format: double example: 1574762.08 manhours_Direct: type: number description: Direct manhours format: double example: 85051.33 manhours_Indirect: type: number description: Indirect manhours format: double example: 0 manhours_Total: type: number description: Total manhours format: double example: 85051.33 addon_Cost: type: number description: Addon cost format: double example: 476452.03 bond: type: number description: Bond cost format: double example: 79798.46 addon_Markup: type: number description: Addon markup format: double example: 0 addon_Total: type: number description: Total addon (markup + cost) format: double example: 476452.03 totalCost_Takeoff: type: number description: Total cost (takeoff) format: double example: 19614331.56 job_Duration: type: number description: Job duration (in months) format: double example: 30 balMarkup_Takeoff: type: number description: Bal­Markup_­Takeoff format: double example: 1327053.97 actualMarkup_Takeoff: type: number description: Markup on total (takeoff) format: double example: 1327087.18 balancedBid_Takeoff: type: number description: Balanced bid total (takeoff) format: double example: 20941385.53 passThrough_Cost: type: number description: Cost of pass through biditems format: double example: 0 passThrough_Adjustment: type: number description: Pass through total – pass through cost format: double example: 0 passThrough_Total: type: number description: Total of pass through biditems format: double example: 0 totalCost_Bid_LessPassThrough: type: number description: Total cost (bid) - total pass through cost format: double example: 19614331.56 totalCost_Bid: type: number description: Total cost (bid) format: double example: 19614331.56 total_User_Adjustments: type: number description: Adjusted markup + cost adjustments format: double example: 0 total_User_Adjustments_Cost: type: number description: Adjusted cost + adjusted addon/bond format: double example: 0 desired_Bid: type: number description: Desired bid total format: double example: 20941385.53 desired_Bid_Diff: type: number description: Difference between desired and actual (bid) format: double example: 33.21 bidTotal_Takeoff: type: number description: Bid total (takeoff) format: double example: 20941418.74 totalCost_Takeoff_LessPassThrough: type: number description: Total cost (takeoff) - total pass through format: double example: 19614331.56 markupPercentCost_Takeoff: type: number description: Actual markup (takeoff) / (total cost (takeoff) – pass through cost) format: double example: 0.06765905 markupPercentCost_Bid: type: number description: Actual markup (bid) / (total cost (bid) – pass through cost) format: double example: 0.06765905 markupPercentSales_Takeoff: type: number description: Actual markup (takeoff) / bid total (takeoff) format: double example: 0.0633714 markupPercentSales_Bid: type: number description: Actual markup (bid) / bid total (bid) format: double example: 0.0633714 totalCost_Takeoff_LessPassThroughAndAdjustments: type: number description: Total cost (takeoff) – pass through - adjusted amount - adjusted markup - adjusted bond/addon - adjusted pass through format: double example: 19614331.56 totalCost_Bid_LessPassThroughAndAdjustments: type: number description: Total cost (bid) – pass through - adjusted amount - adjusted markup - adjusted bond/addon - adjusted pass through format: double example: 19614331.56 totalEntryCost_Bid_Spread_Indirect: type: number description: Indirect bid spread (bid) format: double example: 1712016.53 addonBond_Cost_Bid_Spread_Total: type: number description: Addon bond spread format: double example: 556250.48 totalCost_Bid_Spread: type: number description: Total cost based on bid quantity, not including markup. format: double example: 19614331.55 balMarkup_Bid_Spread: type: number description: Balanced markup based on bid quantity. format: double example: 1327053.97 actualMarkup_Bid_Spread: type: number description: Actual markup spread on bid quantity. format: double example: 1327087.19 actv_User_Quan1: type: number description: Total activity user defined 1 format: double example: 0 actv_User_Quan2: type: number description: Total activity user defined 2 format: double example: 0 actv_User_Quan3: type: number description: Total activity user defined 3 format: double example: 0 actv_User_Quan4: type: number description: Total activity user defined 4 format: double example: 0 open_Biditems: type: number description: Unreviewed biditems format: double example: 9 minority_Goal_Percent: type: number description: Target minority percent format: double example: 0 minority_Goal_Total: type: number description: Target minority total format: double example: 0 minority_Current_Percent: type: number description: Current minority percent format: double example: 0 minority_Current_Total: type: number description: Current minority total format: double example: 0 risk_Dollars: type: number description: Total risk format: double example: 0 risk_Items: type: number description: Risk Items format: double example: 0 summaryDateString: type: string description: The string representation of the last time summary was run example: '' summary_Date: type: string description: The last time summary was run format: date-time nullable: true example: '2019-07-01T11:25:00Z' spreadDateString: type: string description: The last time spread was run example: '' spread_Date: type: string description: The last time spread was run format: date-time nullable: true example: '2019-07-01T11:25:00Z' EstimateNotes: type: object additionalProperties: false properties: notes: type: string maxLength: 10000 ODataQueryOptionsOfEstimateIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfEstimateIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfEstimateIntegrationDto' ETagOfEstimateIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false IntegrationResponseSingleOfEstimateIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/EstimateIntegrationDto' IntegrationResponseOfKPI: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/KPI' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 KPI: type: object additionalProperties: false properties: id: type: string description: The unique identifier of the KPI format: guid example: 0f7a6dc7-e470-4efa-be33-f932ec7ad1d6 name: type: string description: The name of the KPI nullable: true example: Burden / Total Labor leftField: type: string description: The name of the left field nullable: true example: Burden rightField: type: string description: The name of the right field nullable: true example: Total Labor operator: type: string description: The operator to use when calculating the resulting value nullable: true example: '%' values: type: array description: The calculated values for all comparison estimates nullable: true example: - 8.24 - 11.62 - 11.62 - 11.62 - 11.62 - 11.62 - 25 - 25 - 25 - 25 - 25 - 25.22 - 32.88 - 33.89 - 33.89 - 33.99 - 33.99 - 34 - 34.16 - 34.36 - 36.16 items: $ref: '#/components/schemas/KPIValue' stats: description: Summary statistics for all estimates nullable: true oneOf: - $ref: '#/components/schemas/KPIStats' currentValues: description: Values related to the current estimate nullable: true oneOf: - $ref: '#/components/schemas/KPICurrentValues' resultDecimals: type: integer description: How many digits after the decimal to include on the resulting value format: int32 example: 2 rightDecimals: type: integer description: How many digits after the decimal to include on the right value format: int32 example: 4 leftDecimals: type: integer description: How many digits after the decimal to include on the left value format: int32 example: 4 originType: description: Flag representing whether the KPI is standard or imported from HeavyBid example: 0 oneOf: - $ref: '#/components/schemas/KeyIndicatorOriginType' KPIValue: type: object additionalProperties: false properties: value: type: number format: double estimateCode: type: string nullable: true estimateName: type: string nullable: true KPIStats: type: object additionalProperties: false properties: iqr: type: number description: The inter-quartile range. Representing by taking Q3 - Q1 format: double example: 22.37 min: type: number description: The minimum value of all estimates in the calculation format: double example: 8.24 max: type: number description: The maximum value of all estimates in the calculation format: double example: 36.16 q1: type: number description: The value at quartile 1. 25% of estimates fall below this number, 75% fall above this number format: double example: 11.62 q2: type: number description: The value at quartile 2 (the median). 50% of estimates fall below this number, 50% fall above this number format: double example: 25 q3: type: number description: The value at quartile 3. 75% of estimates fall below this number, 25% fall above this number format: double example: 33.99 lower: type: number description: The calculated lower bound of outliers (Q1 - IQR*1.5) format: double example: -21.935 lowerActual: type: number description: The lowest actual value that falls above the calculated lower bound of outliers format: double example: 8.24 upper: type: number description: The calculated upper bound of outliers (Q3 + IQR*1.5) format: double example: 67.545 upperActual: type: number description: The highest actual value that falls below the calculated higher bound of outliers format: double example: 36.16 KPICurrentValues: type: object additionalProperties: false properties: result: type: number description: The calculated result for the current estimate format: double example: 34 left: type: number description: The left operand value for the current estimate format: double example: 197968.59 right: type: number description: The right operand value for the current estimate format: double example: 582214.87 KeyIndicatorOriginType: type: integer description: '' x-enumNames: - Standard - Imported - Insight enum: - 0 - 1 - 2 IntegrationResponseOfMaterialCodebookIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/MaterialCodebookIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 MaterialCodebookIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique material codebook resource id. format: guid example: D5F4A833-CF86-4B64-8585-5847315E0994 systemBackupId: type: string description: The unique system backup id that this record came from. format: guid example: D6884E8E-81B5-4549-BD6E-3BC6A0992B47 resourceCode: type: string description: The resource code. nullable: true example: 2A8100 description: type: string description: The description. nullable: true example: Base unitCost: type: number description: The unit cost. format: decimal example: 25 unit: type: string description: The unit of measure. nullable: true example: TON categoryLevel: type: string description: The "level" the resource belongs to for treeing purposes. nullable: true example: '4' nonTaxable: type: string description: A flag to represent if the resource is not taxable. nullable: true example: 'N' accountingCode: type: string description: The accounting code. nullable: true example: '' accountingDesc: type: string description: The accounting code description. nullable: true example: '' mhPerUnit: type: number description: The manhours needed in the crew per unit when using resource factoring production. format: decimal example: 0 lastUpdate: type: string description: The last date the record was modified. format: date-time nullable: true example: '2022-02-10T03:09:48Z' lastUpdateUser: type: number description: The user number of the person to last edit the record. format: decimal example: 491491 quoteFolder: type: string description: The default class/folder of the resource for the quote system. nullable: true example: RCP resourceText1: type: string description: The resource text 1. nullable: true example: '' resourceText2: type: string description: The resource text 2. nullable: true example: '' scheduleCode: type: string description: The code to be used instead of the resource code when exporting to primavera. nullable: true example: '' excludeFromQuotes: type: string description: 'A flag to exclude the detail when populating quote folders. ' nullable: true example: 'Y' ODataQueryOptionsOfMaterialCodebookIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfMaterialCodebookIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfMaterialCodebookIntegrationDto' ETagOfMaterialCodebookIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false IntegrationResponseSingleOfMaterialCodebookIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/MaterialCodebookIntegrationDto' MaterialCodebookIntegrationUpdateDto: type: object additionalProperties: false properties: description: type: string description: The description. nullable: true example: Base unitCost: type: number description: The unit cost. format: decimal nullable: true example: 25 unit: type: string description: The unit of measure. nullable: true example: TON nonTaxable: type: string description: A flag to represent if the resource is not taxable. nullable: true example: 'N' accountingCode: type: string description: The accounting code. nullable: true example: '' accountingDesc: type: string description: The accounting code description. nullable: true example: '' mhPerUnit: type: number description: The manhours needed in the crew per unit when using resource factoring production. format: decimal nullable: true example: 0 quoteFolder: type: string description: The default class/folder of the resource for the quote system. nullable: true example: RCP resourceText1: type: string description: The resource text 1. nullable: true example: '' resourceText2: type: string description: The resource text 2. nullable: true example: '' scheduleCode: type: string description: The code to be used instead of the resource code when exporting to primavera. nullable: true example: '' excludeFromQuotes: type: string description: 'A flag to exclude the detail when populating quote folders. ' nullable: true example: 'Y' IntegrationResponseOfApiDatabasePartitionRead: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/ApiDatabasePartitionRead' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 ApiDatabasePartitionRead: type: object additionalProperties: false required: - id properties: id: type: string description: The id. format: guid minLength: 1 example: 4621c8dd-c771-4690-9c01-39534ad9940d systemId: type: string description: The heavybid system id. format: guid example: 35e94b82-d9a8-4e9f-b52d-45f27e45154b businessUnitId: type: string description: The setups business unit id. format: guid example: b63bbfcf-8598-43f5-9e5a-90cd6255d071 businessUnitCode: type: string description: The setups business unit code. nullable: true example: b63bbfcf-8598-43f5-9e5a-90cd6255d071 divisionId: type: string description: The HeavyBid divisionId. format: guid example: b63bbfcf-8598-43f5-9e5a-90cd6255d071 divisionCode: type: string description: The HeavyBid division code. nullable: true example: b63bbfcf-8598-43f5-9e5a-90cd6255d071 IntegrationResponseSingleOfApiDatabasePartitionRead: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/ApiDatabasePartitionRead' IntegrationResponseOfResourceIntegrationDto: type: object additionalProperties: false properties: data: type: array description: Response data nullable: true items: $ref: '#/components/schemas/ResourceIntegrationDto' currentTopValue: type: integer description: The current top value format: int32 nullable: true example: 100 currentSkipValue: type: integer description: The current skip value format: int32 nullable: true example: 0 nextSkipValue: type: integer description: Current top value + current skip value format: int32 nullable: true example: 100 ResourceIntegrationDto: type: object additionalProperties: false properties: id: type: string description: The unique resource id. format: guid example: 25dbb66d-bf4d-421f-a2df-f15765287dc3 estimateId: type: string description: The estimate id. format: guid example: 483e8356-7c9d-4949-b882-154072a8e38a estimateCode: type: string description: The estimate code. nullable: true example: 1-BRIDGE biditemId: type: string description: The biditem id. format: guid example: db7284b1-b1d2-4eb3-9361-dfc88aa36bab activityId: type: string description: The activity id. format: guid example: 2cf04cfb-7f3d-4456-9bd7-7513c725f5fc lastModified: type: string description: The last modified date. format: date-time example: '2022-02-10T03:09:48Z' resourceCode: type: string description: The resource code. nullable: true example: 2EC10 activityCode: type: string description: The activity code. nullable: true example: 290001 biditemCode: type: string description: The biditem code. nullable: true example: 140 description: type: string description: The description. nullable: true example: Silt Fence typeCost: type: string description: |- Type of cost (labor, equipment, sub, etc.) this record contains: "L" = Labor type "E" = Equipment or non labor equipment type "P" = Permanent Material Type "C" =Construction Material Type "S" = Sub "1" = Misc 1, "2" = Misc 2 "3" = Misc 3 nullable: true example: P typeOfEquipmentRent: type: string description: |- Type of equipment rent. This only applies to equipment records and notes if the rent is inside or outside rent (or blank which means equipment operating expense). nullable: true example: '' subType: type: string description: The sub type. nullable: true example: '' quantity: type: number description: The quantity. format: decimal example: 45000 units: type: string description: The unit of measure. nullable: true example: LF percent: type: number description: |- Used depending on the record cost type: Labor - This is the overtime premium percent Other costs - This is the tax percent format: decimal example: 100 unitPrice: type: number description: Unit cost for everything except labor. Labor will only have the base rate here. format: decimal example: 1.15 currency: type: string description: The currency the unit price was entered in. nullable: true example: US$ subTypeCost: type: number description: For equipment, this is the equipment operating expense costs. For labor, this is the burden (tax and fringe) costs. format: decimal example: 0 total: type: number description: The total. format: decimal example: 51750 factorable: type: string description: |- This is pulled from the activity record. It determines if the quantity should be able to be factored based on bid/takeoff differences. It should always match the activity parent factorable field. nullable: true example: 'Y' factor: type: number description: Bid/TO factor format: decimal example: 1 supplementalDescription: type: string description: Supplemental description field for user customization. nullable: true example: '' skipCost: type: string description: If Y this is a non-additive cost in the estimate, otherwise it is a cost in the estimate. nullable: true example: 'N' pieces: type: number description: |- Number of pieces of equipment or number of labor craft in a crew. Otherwise, this is the waste factor of materials. format: decimal example: 0 operatingPercent: type: number description: |- Equipment operating expense (EOE) %. Percent to apply to the quantity for determining the operating cost of equipment. If this is 50%, the equipment operating expense is only charged to ½ the hours of the equipment." format: decimal example: 0 rentPercent: type: number description: |- Percent to apply against the quantity to determine the equipment rent charge for the resource. If it is 80% and the crew is running 10 hours, it only charges for the first 8 hours of rent (80% of 10 hours)." format: decimal example: 0 productionCode: type: string description: |- Material factor type -- either blank, A, or C. Determines if the resource is factored by activity quantity or crew hours. nullable: true example: '' production: type: number description: Material factor of the resource. format: decimal example: 0 crewCode: type: string description: If set, the resource belongs to this crew. nullable: true example: '' equipmentOperatorCode: type: string description: Labor code that operates this record (if it is equipment). nullable: true example: '' escalationPercent: type: number description: Average escalation percent to be used on this resource. format: decimal example: 100 plugIndicator: type: string description: |- If this resource has a selected vendor in quotes where the plug price is still being used, this will be set to P. Default is blank. nullable: true example: '' calendar: type: string description: The calendar. nullable: true example: '' startDay: type: string description: The start day, nullable: true example: '' specialSchedule: type: string description: The special schedule. nullable: true example: '' manHourAdjustmentPerShift: type: number description: The man hour adjustment per shift. Used for labor and equipment that use more or less hours than the calendar (per line, not per piece) format: decimal example: 0 selectedVendor: type: string description: The vendor code of the selected vendor for this resource in the quote system. nullable: true example: '' manHourUnit: type: number description: Factor for using resource factoring production (RF). format: decimal example: 0 escalationOverride: type: string description: If set, the resource doesn't use the same escalation as the default escalation for its cost type. nullable: true example: '' class: type: string description: The class/folder this resource belongs to in the quote system. nullable: true example: '' alternateQuantity: type: number description: The alternate quantity. format: decimal example: 0 alternateUnits: type: string description: The alternate unit. nullable: true example: '' resourceText1: type: string description: The resource text1. nullable: true resourceText2: type: string description: The resource text2. nullable: true accountingJCCode: type: string description: The resource accounting code nullable: true dispatcherType: type: string description: The dispatcher export type nullable: true example: '' dispatcherSubType: type: string description: The dispatcher export sub type nullable: true example: '' ODataQueryOptionsOfResourceIntegrationDto: allOf: - $ref: '#/components/schemas/ODataQueryOptions' - type: object additionalProperties: false properties: ifMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfResourceIntegrationDto' ifNoneMatch: nullable: true oneOf: - $ref: '#/components/schemas/ETagOfResourceIntegrationDto' ETagOfResourceIntegrationDto: allOf: - $ref: '#/components/schemas/ETag' - type: object additionalProperties: false IntegrationResponseSingleOfResourceIntegrationDto: type: object additionalProperties: false properties: data: description: Response data nullable: true oneOf: - $ref: '#/components/schemas/ResourceIntegrationDto' securitySchemes: bearer: type: oauth2 description: oauth2 flows: clientCredentials: tokenUrl: https://api.hcssapps.com/identity/connect/token scopes: heavybid:read: heavybid:read heavybid:write: heavybid:write heavybid:system:read: heavybid:system:read heavybid:system:write: heavybid:system:write authorizationCode: tokenUrl: https://api.hcssapps.com/identity/connect/token authorizationUrl: https://api.hcssapps.com/identity/connect/authorize scopes: heavybid:read: heavybid:read heavybid:write: heavybid:write heavybid:system:read: heavybid:system:read heavybid:system:write: heavybid:system:write x-generator: NSwag v13.17.0.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))