Meridian Cloud APIs

The Meridian Asset API enables you to integrate Meridian Cloud with other business systems that manage physical assets—such as Computerized Maintenance Management Systems (CMMS), Geospatial Information Systems (GIS), Facility Management (FM) systems, and Enterprise Application Management (EAM) systems. It can help to optimize information flows and provide valuable analytics and reporting insights into how that information is used by your teams.

The API can be used to create assets and their relationships to documents that are used by PowerWeb, Meridian Portal, Meridian Explorer, and Meridian Mobile. The Meridian Cloud API is not a software development kit (SDK) and does not require installation.

• The PUT Asset API creates or updates a Meridian Asset. The GlobalId parameter defines the unique identifier for the asset. If there is an existing Asset with this GlobalId within Meridian then the Asset with be updated, otherwise a new Asset will be created. The request body is expected to contain JSON-formatted data and set the additional Asset properties.

• The POST Relationship API creates relationships between a source Asset and one or more target Assets. The GlobalId parameter defines the unique identifier for the source asset. The request body is expected to contain JSON-formatted data and a collection of Asset GlobalIds which will be related to the source Asset.

• The GET Documents URL API returns a Meridian URL for a given Asset which can be used within a web browser to directly import documents into PowerWeb and associate to the given asset. A document count is also returned for the given asset. The GlobalId parameter denotes the unique identifier of the Asset within PowerWeb. If the asset does not yet exist, then it will be created upon browsing the given Meridian URL and importing documents.

The Asset API is used to integrate with the Accruent applications Maintenance Connection (CMMS), FAMIS 360 (FM), and vxMaintain (EAM). In addition to Accruent integrations, the Asset API can also be used to integrate on–premises applications such as SAP PM and IBM Maximo in combination with the Tag Synchronizer and Tag Link Synchronizer.

The Meridian Configuration API supports the retrieval and update of lookup list definitions and values used by the Meridian Cloud apps. There are two possible scenarios:

1. QUERY — Any third-party data-source can query the available values and retrieve existing values from the Meridian Cloud property lookup lists (custom, built-in, and hierarchical). The property lookup list in Meridian Cloud is the leading source for the third-party data-source.

   The following Configuration API operations are available:

   • The GET Lookup Lists API returns all lookup lists.

   • The GET Lookup List Values API finds a specific lookup list and its values. The Property ID of the required lookup list is passed in the URL.

   • The GET Hierarchies API returns all hierarchy classifications for a given Functional Location, Facility Location, Transmission Classification, or Discipline Classification. The Discipline Classification has separate values per Document Type. The Document Type names must be included as parent value for the root values.

   • The GET Hierarchical Lookup Values API returns all hierarchical lookup lists values for the given hierarchy. The Discipline Classification has separate values per Document Type. The Document Type names should be included as parent value for the root values.

2. CREATE, UPDATE and DELETE — The third-party data-source can create, update, and delete values to Meridian Cloud property lookup lists (custom, built-in, and hierarchical). The property lookup list values in Meridian Cloud are the target for the third-party data-source.

   The following Configuration API operations are available:

   • The PUT Batch Update Lookup List Values API replaces a complete set of Lookup List values. New entries are created, existing entries are updated, and missing entries are deleted. The PropertyID is not required otherwise the client will need to store and match these when syncing data.

   • The PUT Batch Update Hierarchical Lookup List Values API batch updates Hierarchical Lookup List Values for the specified list. The input model is the same as the list of values returned by the GET request. For the Discipline Hierarchical Lookup List (where the Discipline property is being updated) the parent will be set to the name of the associated Document Type.

The Meridian Cloud Project Exchange API supports the exchange of project package information and documents with 3rd party applications, including status and metadata. From a 3rd party application, it is possible to modify Meridian documents and send the updated documents back to Meridian.

The following APIs are available in the Project Exchange API :

• Get Projects endpoint in API is created. It retrieves all projects per tenant. Accepts page number and page size as filter options. Based on the result that Get Project endpoint retrieves, we can filter other endpoint calls.

  • Get Contractor Packages API – detects if there are new packages available for the contractor inside the tenant. Packages sent from Meridian can be changed by a user that has the Contractor role. That means that Meridian sent packages of type RETURN and when arriving in Portal the status is Active. Accepts three filter options besides page number and page size: PackageType, PackageType, ProjectIDs.

  • POST Acknowledge Package API – acknowledge command for a certain packageIDs and projectIDs.

  • GET Contractor Package Documents API – retrieves all documents per project ID and package number. Accepts package number, page number, page size, and project ID as filter options.

  • POST Package content Export API – starts the export command for a certain packageIDs, projectIDs, and specified stream type.

  • HEAD Export Package Content Header API – returns headers which the client can use to determine:

    • if the call to download a Package Content Export supports partial downloads, and

    • the size of the entire file.

  • POST Download Package Content API – supports resumable document downloads and catered for large files. The client can download data in chunks and perform a partial download.

  • POST Resumable API – returns the resumable upload URL which can be used to perform a chunked data transfer. The unique identifier (GUID) for the uploaded file is included in the URL and will be used in the final commit of the file to a Project Document.

  • POST Resumable file upload API – supports upload of large files in chunks.

  • POST Commit Uploaded Data Chunks API – commits all data chunks that have been uploaded.