Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CMiC Projects API

Construction project management

CMiC Projects API is one of 7 APIs that CMiC publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, and 1 JSON Schema.

This API exposes 4 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cmic.ca/rest.

4 operations 2 paths 6 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.cmic.ca
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

CMiC Projects API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 client credentials for CMiC API access

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 4

Construction project management

GET
/pm-rest-api/v1/PMproject
List construction projects
listProjects 4 params → 200401403
POST
/pm-rest-api/v1/PMproject
Create a new construction project
createProject body → 201400
GET
/pm-rest-api/v1/PMproject/{projectId}
Get project details
getProject 1 param → 200404
PUT
/pm-rest-api/v1/PMproject/{projectId}
Update project details
updateProject 1 param body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ProjectRequest (6 properties), Address (5 properties), ProjectSummary (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ProjectSummary
object
5 properties
ProjectList
object
3 properties
Address
object
5 properties
Error
object
3 properties
Project
ProjectRequest
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cmic-projects-api-openapi.yml Raw ↑

Other APIs CMiC publishes across the network.

CMiC API Power BI Connector
CMiC Cost Tracking API
CMiC Documents API
CMiC Equipment API
CMiC Jobs API
CMiC Subcontractors API