Reference · built on requestConnectorField service & CMMS

HxGN EAM

Work orders, equipment, parts, and purchase orders from HxGN EAM through its OpenAPI 3 REST web services.

About

HxGN EAM is Hexagon's enterprise asset management system for plants, fleets, facilities, and transit operators. It holds equipment records for assets, positions, and systems, plus work orders, task plans, parts, requisitions, purchase orders, and suppliers. Every record view and tab in EAM is exposed as a REST web service under /axis/restservices, defined in OpenAPI 3 and browsable at {yourEAMApplicationServer}/web/swagger/index.html.

Through Fibric, an operator reads work orders and equipment with GET Collection and grid calls, then proposes a new work order, a comment, or a PATCH to selected fields. You approve each change; it is applied once and leaves a receipt of what changed and why.

This is a reference listing. It documents what Fibric would read from HxGN EAM and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Work orders through GET /axis/restservices/workorders, or one record by {id}, the work order number and organization code joined with #
  • Work order comments and activities through the child services /workorders/comments and /workorders/activities
  • Equipment records for assets, positions, and systems, each returned with its default entity schema
  • Any EAM grid, including the Work Order and Alerts list views, through POST /axis/restservices/grids with a GRID_NAME and DATASPY_ID
  • Grid contents as CSV with column labels, aliases, and data types through /axis/restservices/csvgrids
  • Comment tabs for parts, purchase orders, requisitions, suppliers, task plans, and cases, returned as a COMMENT array

Proposed actions

  • Target capability: propose a new work order through POST /axis/restservices/workorders, starting from the sample body the Swagger API provides
  • Target capability: propose a PATCH to selected work order fields such as REQUESTEDSTART, leaving fields absent from the request untouched
  • Target capability: propose a work order comment through POST /axis/restservices/workorders/comments
  • Target capability: propose a work order activity through POST /workorders/activities

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Pull the backlog into a working order

    The Work Order grid returns open orders with their requested start dates. The operator proposes which corrective and PM orders to bring forward and records the reason on each.

    With Work Order Aging, Backlog Priority

  • Raise a corrective order before the PM date

    Readings from a controller show an asset drifting. The operator proposes a work order on that equipment through POST /workorders and waits for your approval.

    With Predictive Maintenance

  • Reorder parts a work order consumed

    Part and purchase order screens show what fell below stock after a job. The operator proposes the purchase order and a comment on the part record for your approval.

    With Parts Reorder

  • Give field crews a day list

    Work orders due today come from the Work Order grid. The operator proposes an order of work for each crew and, once approved, a comment on each work order.

    With Field Dispatch

Requirements

  • An HxGN EAM tenant, cloud or on-premise, with REST web services reachable at {yourEAMApplicationServer}/axis/restservices
  • A user record with Connector selected in the HxGN EAM Products section
  • A user group whose Interface Permissions tab grants Query, Insert, Update, or Delete on each web service the operator calls
  • A default Dataspy on each screen that includes every field the web service needs
  • The install parameter LGNCON set to STD, LDAP, or EXTERN to match how the connector user authenticates
Authentication
An EAM user record with the Connector checkbox selected, presented as Basic auth username and password, an API key, or an OIDC bearer token per the HxGN EAM OpenID Connect guide; every request also carries tenant, Organization, and Role headers.

Limits

  • GET Collection returns RSCLROWS rows per call; grid fetches are capped by WSGRIDSZ and paged with cursorposition
  • PUT replaces the whole record and blanks fields you omit; PUT and PATCH need a recordid that matches the database or EAM rejects the write
  • Date fields carry the year as epoch milliseconds unless the 12.3 install parameter RSYRYYYY is set to YES
  • Hexagon's REST web services guide covers request and response only, with no webhook section; change detection polls collections and grids

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request HxGN EAM ↗

Questions and answers

Where is the HxGN EAM REST API documented?
In the Swagger UI your EAM server hosts at {yourEAMApplicationServer}/web/swagger/index.html. Each REST web service is defined in OpenAPI 3 with a sample {id} and sample request bodies. Deprecated services sit in their own menu section and should not be used in new work.
Which headers does every request need?
tenant, Role, and Organization identify the EAM tenant, the user's role, and the default organization. apiversion is optional. keepsession true returns a sessionid you can reuse for a persistent HTTP connection. clonedscreen names a cloned screen on GET Collection, and authenticationmode internal bypasses the LGNCON install parameter.
How do PUT and PATCH differ?
PUT replaces the record; any field not in the request is blanked. PATCH updates only the fields you send. Both check recordid. If it does not match the database value, EAM answers that the record has been modified by another user and rejects the write.
Ask about HxGN EAM

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.