Before you start:You must be a part of a registered customer or team on ATLAS to use this API. Please refer to our Getting Started page for instructions on creating a customer
Your ATLAS domain
All teams and enterprise customers on ATLAS are assigned a unique domain. Any API calls must be made to that domain.
[your-domain].enablemyteam.com
If you're unsure of your domain, please login from enablemyteam.com
In most cases, you will be redirected to your domain after login. However, your customer configuration might be using an external enterprise sign on. Please email our help desk at [email protected] and we will help you with your domain.
EMT Documents API (Swagger)
Using this API endpoint, you can interact with the following datasets:
- Documents (PDF, Excel, DOCX, PPTX)
- 3D Model Formats (DGN, DWG, IFC, REVIT and more)
- 2D Drawings (DGN, DXF)
Documents Data Model
Hight level data model for EMT Documents
EMT Documents is built on top for ATLAS Asset Information management data model. As such, Document and Comment are asset types. Valid requests and responses from the API will return a JSON response consistent with the API data model described in specification for each endpoint. All data extracted from unstructured, structured or 3rd party systems is described as an "asset".
See below recipe for retrieving asset schema from ATLAS:
Document Attributes
| Attribute Name | EMT Documents API Json Mapping | Type | Notes |
|---|---|---|---|
| Document Number | attribute.Document Number | String | For a pack document, this will be the pack number. Ex: Pack 2342 Pack [pack number] |
| Document Name | attribute.Document Name | String | |
| Document Pack | attribute.Document pack | String | Name of the pack the document is in. There is also an asset relation of the document to a parent pack |
| Document Revision | attribute.Revision | String | |
| Document Stage | Inferred from Document Responsibility and Review Iteration: Unassigned - Review Iteration is missing and Document Responsibility is missing Under Review - Review Iteration=1.0 and Document Responsibility="With Reviewer" Awaiting Response - Review Iteration=1.0 and Document Responsibility="With Author" Follow Up Review - Review Iteration=2.0 and Document Responsibility="With Reviewer" Completed - Review Iteration=2.0 and Document Responsibility="Completed" | String | |
| Document Responsibility | attribute.Document Responsibility | String | With Author With Reviewer Completed Not populated when document is in Unassigned stage |
| Review Iteration | attribute.Review Iteration | Number | ex: 1.0, 2.0. Not populated wth document is in Unassiged stage |
| Review Time | attribute.Review Time (In Days) | String | ex: "21" |
| Review Coordinator | attribute.Review Coordinator | String | Comma separated list of emails |
| Reviewers | attribute.Reviewers | String | Comma separated list of emails |
| Lead Author | attribute.Lead Author | String | Comma separated list of emails |
| Author | attribute.Created By | String | Comma separated list of emails |
| Document Status | attribute.Document Status | String | Configurable set of Status code |
| File | File | JSON | File metadata |
| File Type | Mime type of the document. | String | File Type = "Document Pack" if its a Pack document |
| Document Import Time | imported_datetime | datetime | |
| Document Added in Repo/CDE | attribute.DateAdded | datetime | This timestamp usually comes from the repo a document is synced from |
| Document Modified in Repo/CDE | attribute.DateChanged | datetime | This timestamp usually comes from the repo a document is synced from |
| Review Context | attribute.Document Differentiator | String | This is a string used to set a review context. Allows for same document to be potentially reviewed in different contexts |
Comment Attributes
| Attribute Name | EMT Documents API Json Mapping | Type | Notes |
|---|---|---|---|
| Comment Number | attribute.Comment Number | String | Auto-generated |
| Comment Type | attribute.Comment Type | String | Configurable drop-down |
| Code | attribute.Code | String | Configurable list of comment codes |
| Recorded By | attribute.Recorded By | String | email of Comment creator |
| Recorded At | attribute.Recorded At | datetime | |
| Message | attribute.Message | String | Comment body or response message If Head is not True, then its a comment body otherwise a response or threaded comment. |
| Head | attribute.Head | String | True or False. True if its a head/first comment. For responses and followup or threaded comments, this will be False |
| Responded By | attribute.Responded By | String | email of responder |
| Responded At | attribute.Responded At | datetime | |
| num_parent_relations | num_parent_relations | int | 0 or 1. For responses or threaded comments, this value is 1. Responses and threaded comments are linked to original head comment via an asset relation |
| Status | Open or Closed | String | |
| Document | tag_code of the associated document revision | String | |
| File ID | EMT attachment Id of the physical file | String |
For any help, feel free to email [email protected]
Don't forget the what's next section below to continue learning a bit more about our API