Industrial Database API

Version 2.0 (latest)

Released: 28-June-2022

• RapiDoc

Version 1.4

Released: 25-Jan-2022

• RapiDoc

Version 1.3

Released: 04-Aug-2021

• RapiDoc

• Welcome Letter
• What IDB API is and is not (API vs. Fulfillment)
• IDB API Version Support Policies
• Tips for API Clients
• API Client Code Examples
  • Offline Event API (Javascript)
  • Project API (PowerBI)
  • Plant API (Tableau)
• Get Email Notification of API Updates

• Version 2.0.4 (24-Jan-2023)
• Included bug fixes.
• Version 1.4.10 (24-Jan-2023)
• Included bug fixes.
• Version 1.3.10 (24-Jan-2023)
• Included bug fixes.
Show All Hide
Version 2.0.3 (08-Nov-2022)
• Internal system improvements.
Version 1.4.9 (08-Nov-2022)
• Internal system improvements.
Version 1.3.9 (08-Nov-2022)
• Internal system improvements.
Version 1.2.11 (08-Nov-2022)
• Internal system improvements.
Version 2.0.2 (25-Aug-2022)
• Added nercRegion, isoRtoRegion, controlAreaId, controlAreaName, tradingRegionId, tradingRegionName, associatedEntityType and firstUnit search parameters to the offlineevents/summary endpoint.
• Included bug fix.
Version 1.4.8 (25-Aug-2022)
• Included bug fix.
Version 1.3.8 (25-Aug-2022)
• Included bug fix.
Version 1.2.10 (25-Aug-2022)
• Included bug fix.
Version 2.0.1 (22-July-2022)
• Included bug fixes and improvements.
Version 1.4.7 (22-July-2022)
• Included bug fixes and improvements.
Version 1.3.7 (22-July-2022)
• Included bug fixes and improvements.
Version 1.2.9 (22-July-2022)
• Included bug fixes and improvements.
Version 2.0.0 (28-June-2022)
• Redesigned Offline Event Search to allow the searching for offline plants, offline units and offline assets (pipelines and transmission lines). See Migrating from v1 to v2 Guide for additional info.
Version 1.4.4 (28-June-2022)
• Modified Offline Event Search to maintain backward compatibility.
Version 1.3.4 (28-June-2022)
• Modified Offline Event Search to maintain backward compatibility.
Version 1.2.6 (28-June-2022)
• Modified Offline Event Search to maintain backward compatibility.
Version 1.4.3 (10-May-2022)
• Added prevStartDate and prevEndDate fields to the offline event summary.
• Included bug fixes.
Version 1.3.3 (10-May-2022)
• Added prevStartDate and prevEndDate fields to the offline event summary.
• Included bug fixes.
Version 1.2.5 (10-May-2022)
• Added prevStartDate and prevEndDate fields to the offline event summary.
• Included bug fixes.
Version 1.4.2 (25-Feb-2022)
• Internal upgrade.
Version 1.3.2 (25-Feb-2022)
• Internal upgrade.
Version 1.2.4 (25-Feb-2022)
• Internal upgrade.
Version 1.4.1 (25-Jan-2022)
• Added Estimated TIV to Offline Event Search.
• Included bug fixes.
Version 1.4.0 (16-Nov-2021)
• Added new endpoint for Labor Project Duration data.
• Added recordStatus to Plant Search.
• Added existingSqFt to Plant Search.
• Added existingSqFt, newSqFt and retrofittedSqFt to Project Search.
• Modified Market Trend from single value to multiple values.
• Discontinued Production Field endpoints.
Version 1.3.1 (16-Nov-2021)
• Discontinued Production Field endpoints.
Version 1.2.3 (16-Nov-2021)
• Discontinued Production Field endpoints.
Version 1.3.0 (04-Aug-2021)
• Added Industry Codes to Company Search based on the plants that a company owns.
• Added Company Types to Company Search.
• Added Plant Details and Unit Details to Plant and Unit Search respectively.
• Removed engineeringYearMonth field from Project details.
• Updated RapiDoc which includes a number of bug fixes and several new features.
• Included various bug fixes and improvements.
Version 1.2.2 (04-Aug-2021)
• Added Company Types to Company Search.
• Deprecated engineeringYearMonth field from Project details.
Version 1.1.5 (04-Aug-2021)
• Added Company Types to Company Search.
• Deprecated engineeringYearMonth field from Project details.
Version 1.0.5 (04-Aug-2021)
• Included bug fixes.
Version 1.2.1 (20-Jan-2021)
• Improved performance for large results set.
• Added Mobile Flag field.
Version 1.1.4 (20-Jan-2021)
• Improved performance for large results set.
• Added Mobile Flag field.
Version 1.0.4 (20-Jan-2021)
• Improved performance for large results set.
• Added Mobile Flag field.
Version 1.2.0 (10-Nov-2020)
• Added Market Trend to Project Search.
• Added Energy Storage and Power-to-X Key Needs to Project Search.
• Added Mining Equipment Owner to Mining Equipment details.
• Added plant contact alternate phone number to Plant details.
• Modified the data structure of contacts for Company, Project, Plant and Unit details.
• Modified the data structure of the companies' related entities.
Version 1.1.3 (10-Nov-2020)
• Includes various bug fixes.
Version 1.1.2 (27-Aug-2020)
• Added the ability to specify fields to return for detail endpoints.
• Added Plant Probability to Plant Search.
• Added Project Details to Project Search.
• Replaced Swagger UI and reDoc with RapiDoc as Documentation/Interactive Testing tool.
• Included bug fixes and improvements.
Version 1.1.1 (05-May-2020)
• Improved error messages across all endpoint requests.
• Modified the default and maximum values for the ‘limit’ parameter.
• Reduced the parameters for all detail endpoints to support the entity ID only.
• Standardized date and numeric parameters naming convention.
• Included bug fixes and improvements.
Version 1.1.0 (21-Feb-2020)
• Official release of IIR IDB API.
• Included various bug fixes and improvements.
Version 1.0.0 (25-Sep-2019)
• Beta release of IIR IDB API.