Beschreibung
Wichtige Erkenntnisse
- Understand the relationship between Forge and BIM 360
- Understand the basic structure of the Forge Data Management API
- Learn how to use the Forge Data Management API to access and modify BIM 360 Docs data
- Understand current capabilities and limitations of the API to access BIM 360 Docs
Referent
- Mikako HaradaMikako Harada works as a Senior Manager for the Developer Technical Services team at Autodesk. She provides API support for AEC products. Prior to joining Autodesk, she worked as a researcher for the Swiss Federal Institute of Technology (ETH) in Zurich. While at ETH, she worked with projects involving the development of web-based collaborative environment with the Swiss building industry and web-based visualization projects for business data archive systems, aiming to enlarge our knowledge by a means of visualizing a large amount of information. She was also a researcher at Engineering Design Research Center in Carnegie Mellon University, Dr. Scott Fahlman’s lab (who is known as the father of Common LISP and the person who first sent the smiley face on the Internet), and Artificial Intelligence Cognitive Systems group at General Motors Technical Center. Her interests is in the areas of interactive techniques, optimization and layout synthesis.
MIKAKO HARADA: Thank you very much. My name is Mikako Harada. I'm an AEC technical lead and also managing Americas team for Developer Technical Services. I work for Autodesk quiet some time now. I stopped counting because I'm a little bit sensitive about age-- but quite some time. And today's title is Demystifying the BIM 360 and Forge APIs.
So before-- maybe I will just go ahead. So this is my summary and learning objective. So as I said, I work for Developer Technical Services, which is a team of engineers who now evangelize for this technology as well as helping third parties.
And main motivation I had-- it's kind of funny, because I get a lot of questions, and there are some common questions, which is a little bit special for BIM, because in order to use API for BIMs, you have a little bit of [INAUDIBLE] or special steps to activate. So some of the things which gives you a little bit hard time to figure it out, once you know, it's easy. But if you don't know, you have to hit your head.
So I'm putting a lot of doors within this presentation. But basically, my presentation is very much similar to what I have done in the past. I've been giving this talk a couple times a year now, but basically the same. So if you already experienced BIM 360 Docs API and Forge users, and you may not find anything spectacularly new. So I just wanted to set the right expectations in case you change your mind and go to other classes. So that's my main thing.
So with that, my own motivations, such as-- I don't see apps and integration tabs, which the name itself has now changed. So my old instruction is probably not valid any longer. So nobody would find it. So those are the things I'll be explaining.
So without background, I have a question for you are little bit. I was asking Tom a little bit earlier. How many of you have been using BIM 360 Docs Forge-based BIM already as a developer? How many of you are using Forge? Forge doesn't need to be BIM specific.
So how many of you have attended Tomer's and his team's presentation right before in a room over there? So many of you. I can see quite a few people kind of new. So I think it's probably appropriate.
So I'll be explaining how to get started. This would be like the most first step, and once you get this first step, you'll probably find a lot of very good best practice examples in the Forge portal and GitHub. So this will be my introduction course for the BIM side.
So our agenda today, first I'll go to explain a little bit about BIM 360 and family product. The BIM 360 family product is evolving, and it's evolving little by little. And unlike the traditional desktop product, which we usually announce a big announcement once a year, this BIM and other cloud product, they show the improvement or enhancement every-- they call it a sprint-- a couple of weeks. They actually made it a little bit hard.
Once you don't-- if you stop looking at it, you may find that something had changed when I'm not recognizing. They tried to make it seamless, but if you don't look at for continuously, then it may look like sudden change. So I just wanted to give you the current status of BIM 360 family product, and then I'll explain about Docs, and then Forge APIs.
The relationship-- I want to clarify the relationship between Forge, because there is no such thing as BIM 360 API itself. It's about the 40 API use within BIM 360. So once you have this clear picture, you'll probably get more clear idea about where you should look for to see some more information. So within this overview and Forge API, I'll be explaining a little bit more detail about each component, such as authentications, account level, APIs, and data management, model derivative, viewer. And when I'm explaining this one, I will give you a little bit tips and tricks, which I notice while I'm supported a lot of third party developers.
So first, BIM 360 Docs and their family products. So this looks probably familiar to you. I've been using this as a base for a couple of years now, and if you just look at this quickly, you'll see like, oh, it's the same slide. But if you pay a little bit attention, it's been changing little by little.
So for instance, since the last year, we have this-- oh, sorry. Last year, we have this ops branded and then team also. We have a same B Glue [INAUDIBLE], but it has been changed too.
And the first questions we often get is, I want to use a Glue with a Forge. How can I do? This is a very common questions. And first, Glue is not a part of Forge-- so the field too. So this is one of the important things you have to be aware.
So in order to use, for instance, the Glue model, upload it in Glue, what you have to do is you have to download from Glue and then put it somewhere for the API will support. So historically, as many of you are probably familiar, Glue acquired from Horizontal and Field is acquired from Vela Systems.
So they developed completely different environment. So now, what we at Autodesk is trying to do is they want to use Docs or Forge data storage areas as a common area. So whatever the system or microservices you have, even third party developers application, you get access to the same places. So you do something by developer A application, you do something by Autodesk B application, you do something by developer C application. This will be all down with the whole 4G database.
That's the future direction, but today, team is Forge, Docs is Forge, and then administrative that the feature is also Forge, but other ones are not Forge. Yes, you will see in a couple of slides. So I'm talking about as of today officially. Maybe tomorrow or in a couple of hours it may change.
So the family products. So the whole idea is you probably had the data at the center. That's exactly what Docs is about. So what we are trying to do is we want to use these Docs as a center, the data at the center.
And this is what I wanted-- you wanted to explain. So if you go to next door-- you can hear a little bit of buzz over there. If you go to the next there, you will probably start seeing a few of the management model coordinations. These are the ones-- we've been calling it a "Next Gen," Next Generation Glue and Field.
The name for the Glue and Field will be-- the current Glue and the Field is called the Classic Glue and Field, and then the next generation Field will be the renamed. For instance, Glue will be model coordination. So once the official public beta start, when you go into our domain main page, and you try to subscribe, activate Glue, and you receive two choices.
One is, do you want to connect this project with Glue Classic or a new one? You have a choice. So if you are a Glue customer, if you want to keep using the Glue you have right now, because of urgency, or you don't want to play with a beta, or maybe faster data, you may want to use the other test but not with a real busy project, then you can use the Classic.
Same idea for the Field-- Field also. If you are currently the Field customer, either you are seeing already, or you will be seeing soon. You will see two choices. So we still have a Field in Glue, gut it will be completely new generations.
So I wanted to change this one like this now. So the model coordination would be the next generation Glue, Field management with Field, and then also-- I didn't explain area-- but inside IQ. This is like analytics and machine learning areas [INAUDIBLE] the PM is working on. This will be a part of automation features-- account-level automation features. We will have some analytics there.
It makes sense, because usually those analytics feature is for the project managers. So as you will see, I will be using this one for a while, and then we will see-- at the next conference, I want to see a little bit more evolutions. So what's coming?
If you attended Tomer's presentation over there, there was a roadmap session. So I'm not going to repeat what's coming. But we have folks-- Adam Nagy just gave a talk in this room a couple of minutes-- 20 minutes ago or so, and issued API and RFI submittals, and then checklist also. Those are the ones which is under the scope of what the BIM Team is working on.
And if you are interested in accessing those data-- the product team is still picking only a handful of developers to give access-- but if you are interested in those features, new features, you can contact Tomer's team and you may be able to start using it. But again, if it's a beta, there is a chance that there will be a little bit of tweaks here and there from now to the product release. So be aware, but still, we always welcome developers who likes the leading edge of the new technologies.
So this also-- Tomer was talking about it. I being always keeping eyes on this app tabs, but until even yesterday it was like this. But today, if you go here, you should see the apps like that one is running here.
So one of the things product team is very much emphasizing is that putting up store app, and then app store inside of the product app. This will give you visibility-- what kind of possibility. Just having a data at the center would be giving a lot of the connecting points for various areas of expertise. So this would really give you more ideas of what could be possible with third party developer applications.
And this is just an example. Our colleague, one of my team member, Augusto, he actually created seeding the beginning application. This is already on app store. If you go to BIM 360 app store, even externally, you can actually download this.
And then one of those early app store apps developed by my team is actually providing a source code as well. So if you have something close to it-- I have something very close to it, but I want to customize a little bit-- then in theory we need to take a code, and then tweak it, and use for your company or for your own purposes. So this is the example of trying to explain what is possible.
So I want to show you two examples of partners who has been very actively asking questions to us. I'm not including this as my favorite one. I don't mean that. But in a way, they are very proactively asking us technical questions, and I would say, they are my favorite. But I just wanted to show some of the examples.
So OnTarget, they were at the DevCon last year, and right after DevCon-- they're really fascinated by the capability of the viewer app. They immediately contacted us and they explained what they want to do, and a couple of weeks later they were already implementing something like [INAUDIBLE] in Navisworks, so using the 4D scheduling capabilities. Actually, there is no capability in our viewer, but they added capabilities using viewers.
And then another one is Astralink, that Tomer also showed. Before that, sorry, I wanted to show-- so if you want to see how this looks like there is a class, CS12632, on Thursday by himself. And then also, partner-- I think it might be tomorrow-- there is a partner session, and he will be joining too. So if you are interested in how they are doing, either as a customer or the partner, in the peer partners, you can catch them too.
And they also have a booth. They just told me they have a booth at the AU downstairs. And Astralink also, they are not having a booth, but they have a Forge Village. There is the VR/AR playground in Forge Village. It's behind this main stage we just had this morning, and they are showing-- they are not using these goggles, but they are using the tablet to show.
So they are using augmented reality to the overlay, they drawing image, and then try to reduce the mistakes the fieldwork may have. So this is a very interesting application. They are really, really active asking Forge.help@autodesk.com. So I immediately recognized. Their name. I was very happy because they ask a lot of questions, but I didn't know what they're doing until they showed this. So it was very interesting to find out what they've been doing.
So that's about the product and then what's going on with the third party world related to BIM. And now, a big picture one. This also-- I've been using this a couple of times, the couple of big presentation. So you may be already seeing this, but I'll go through it again.
So the API. There is no such a thing, as I said, Beam 360 API or Docs API, but BIM 360 Docs is using a lot of components. So for instance, authentications, sorry, authentications. You see the login page. You can use the same one as Autodesk is using. And then-- I keep pushing wrong button.
And then BIM 360 API, which is in developer portal site, but it means that it's account-level. I think I forward to change the space, but I don't mean component is here. So in future-- or it could be a temporary rethinks-- but in future, if you see issues and checklist, this may go over there unless it should become a separate standalone API. I'm actually hoping that it will be not specific to BIM, but you can actually use issues API as a standalone and as a component. But maybe we may take some phasings for us as a part of the BIM 360 issues, and then make it more generic.
And then Data Management API. This is the one which has very close correspondence with BIM 360 Docs. So this part is all about accessing data or accessing files, I should say. You have a lot of projects. Within this project, you get into folders, and the folders-- you see more folders or files. So accessing from the big project level, in a bunch of the documentation to specific files, that part will be managed by data management.
And once you reach specific files, it's all about the models. So for instance, if you have a model data, like Revit, then you use a model derivative to extract. So for instance, like the properties and geometries, and also use a viewer to make it be viewable in a web browser. And then I put the little asterisk, because this is not publicly available openly yet. But this is API. This also-- we've been waiting a little bit over one year now-- but issues, and plus, as I said, like checklist and RFI, they are all part of-- will be a part of this BIM 360 Docs API component.
So what about this BIM 360 Team? So historically, BIM 360 Team was part of the A360, and they changed the name, the branding to BIM 360 last year. And sometimes I get a question like, which one do you recommend, Docs or Team? I use it Revit a lot, but I like some of the features in Docs. What shall we do?
So it really depends on what you need, and it's easy to think you want to have both, and you don't want to have files two places. So in future, it would be same one, but right now we still have some framing work to do in the back end. Hopefully, everything will be smooth as one big family, but not today.
And if you want to use the BIM 360 Team, you can use the same authentication API, but there is no automated features there. So you don't need to use BIM 360 API, or you cannot. And then data management API, model derivative, viewer, they are exactly the same, but you need to know a little bit of differences, which I'm coming back later.
And issues API, these are not part of the Team, so obviously, it's not there. But you may have your customers using both Team, for maybe collaboration for Revit, while there may be some few workers who may be using Docs Field features. If that's the case, you may use actually the same API, the data management API to access both with a little tweak. You just need to know a little differences. But other than that, it's exactly the same API. So you don't need to do completely duplicated effort for accessing both.
So now Forge API. So as I keep saying this, there are these type of APIs. So I'm going to explain one by one. So the left side is Team, and right side is Docs. So this is a difference. This is why I'm saying demystifying, the topic of my talk.
So if you are using Team, anybody can use API. Any owner of the team can use it. But if you are using Docs, there is this process in the middle here-- account admin activates API access. So you need to ask the account admin if account admin is not allowing you to access API, not until the end. So that's a little different. Every once in a while I get that, OK, I'm successfully accessing A360, but I don't see BIM hubs. Why? So this is the why, and so this is one of the things you may want to remember.
And how then do you need to activate? So this is a process. So activating API access, first you have to ask your account admin or you have to ask your account admin to make you the account admin. Project admin doesn't allow this, so you have to be account admin.
And then again, Tomer was saying, in future we are having wish list. We want to have a little bit granular control. So for instance, if you were project admin, you may be able to control. Or if you are individuals, you can access only to your folders or your files, but not others. So we want to have a little bit more freedom to access or using API, but right now, it's only for account admin.
So what you have to do is you have to go to the admin page, and then under the Settings tab-- the first one you'll see is the profile-- but you go to the Custom Integration. It used to be Apps and Integration. So if you see older documentation then it may look different, but now it's called Custom and Integrations.
Once you get to this tab, then you'll see Add Integration button. Once you click it here, you'll start the process of integrating, and in order to do that you need some data here. But first thing is, once you click this button you see a choice of selecting access. Is this about accessing account administration, like creating project or Docs? So you can choose.
And once you choose, then you have to put the data. So left side, sorry. Left side, this is the Docs Integration page. So what you need is, you have to take this account ID and check-- read this. But this client ID, what this one is?
So client ID is the one, once you go to a developer portal, developer.autodesk.com, and sign in, you create your own app, My App, under My Apps menu. Then you get the client ID and the client secret assigned to you or specific apps, and you take this client ID and then you enter here. So by this, you're exchanging account ID and then client ID there. So there is some communication with that. And if you are using this end product, Apps Integration, you can skip this one. But if you are creating your own custom apps for yourself or during development period, you have to do this.
And once you-- so that is a process of starting. But another thing is-- this is also very, very common questions I get from the customer-- so I don't see this Custom Integration tabs. And this is probably the case for most of the BIM customers, because what is happening is until early-- during the summer, before the summertime, they activated the Custom Integration tabs only for the BIM 360 users, Docs users, who had 1,000 users.
So it was a big customer. So I could imagine only a handful of customer could use it. But during the summer, we actually reduced it into 100.
So if you have a BIM 360 Docs, but the user number is much smaller, you may not see this tab. If that is the case, we don't stop you. If that is the case, send this request to BIM360AppsActivation@Autodesk.com with the information-- account ID, account name, account admin email. Then the sales team will activate this so you can access for the API.
So this is one of the mystery. You see all these instructions, activate here and here, but I don't see this stuff. So this is one of the mystery. You probably see the-- you can see this all there. You can solve the problem.
And then another small thing. So account ID you can see from here. In this line, you need account name, ID here. This line you can get from this page. So this is under Profile, Settings Profile.
So authentication method. So now we are going into specific detail, the technical detail. So authentication method for BIM 360 Docs, we have two. One is 2-legged and the other one is 3-legged. How many of you are familiar with these 2-legged and 3-legged?
So 2-legged is like you are using client ID and secret, just like login ID and password, and there is no user context there. So that means it's usually suited for company wide integrations, while 3-legged is a user context. So user context means that it will ask you the user, like the page you are seeing here.
The ones-- whenever you use Autodesk product, cloud product, you see this page. This is the one, we call it, "user context," and it is using 3-legged. The 3-legged actually means the three parties, and user is the third one-- application, Autodesk, and the user.
So another thing I want to clarify is that even though we say BIM 360 support 2-legged and 3-legged, it's not completely true, because here, BIM 360 Docs supports both, but BIM 360 Admin on the supports 2-legged. So this is also, in having-- filling those is another gap we want to fill in future. But as of today, this is the one thing you may want to be aware.
So if you are creating something related to account together with Doc, you have a little bit of a dilemma. Now I want to use 3-legged, but the 360 Admin doesn't have it. So you have to do a little bit tweak there, how to give access, but right now it works like this.
And then I had to repeat this one again and again. So 2-legged authentication gives you a superuser power, so you have to be very careful. There is no user context.
You are acting as if you own every other account you have. So that means you can see every data. So if you give the 2-legged power to the end user, that's probably not something you want to have. So whenever you see 3-legged is something you can use, then please make sure you use the 3-legged.
In terms of the implementation, 3-legged has a little bit of challenge in two ways. One is implementing by itself is a little bit more complicated, but this one's probably not the program for you now, because there are lot of utilities. Personally, I use the AirPort authentication, AirPort, the user tools you can get free.
And also another-- second challenge you have is, if you want to develop something for desktop then you have a challenge, because those cloud-based authentication is not designed for desktop. So there is some challenge there. So for that, we also get a lot of questions, and there is a blog, Expanding .NET, the cloud auth.
It's a workaround. It's not a pure solution. It's a workaround, but if you use this then you can probably get away with it for the time being. We may find some better method later, but right now this is the best workaround. So if you are interested in it but you are wondering what is the best way, Augusto wrote a very nice blog post, so please refer to that.
So admin, account admin, also known as BIM 360 API. So this portion is relatively straightforward. This is the data about this project, members, and companies. It all uses 2-legged at this point, so authentication for implementation is very simple, even though, as I said, you have to be careful.
And the last API is quite straightforward. It's a little bit more complicated to access data management. This one is very straightforward, so I'm not going into detail. So this is available.
And then data management API. So this is the ones you probably keep hearing. It's a common across Autodesk products, such as A360, Fusion Lifecycle, Fusion, and consumer projects, such as Tinker CAD. They are also using the same ones.
And data management API, we have a couple services. Project services, which is accessing a project, and data services, object storage services, and schema services. So the data services is the one we often use to access the content of the folder in folders.
And object storage services is used to create or access storage. So for instance, uploading and downloading OSS, object storage services. And schema services is the one you define what kind of a data or extension you are adding to the data management. Usually, for the first step you probably don't need to pay attention to the schema services, but once you start doing a little bit more complex one, you may sneak into this schema definition, then find out what else you can get from the REST APIs.
So this is an example of showing the project. So project means that you can access to the hubs. Once you get the hub IDs, you can get the hub ID and project, and using these, you can get project and so on.
And once you start using data management API, you start recognizing a certain pattern in response, which looks like this. So you have a whole routine, the format, like a JSON API links, data. Underneath of data, it usually have type and IDs.
So type and IDs are important ones. For instance, if you want to access to the project, as you usually pickup this data-- B, great-- and then you use this one to access next level. So project next level means that folders, top folders. So those are the data you usually use.
And extension is the ones you can get additional information. For instance, A360 is supposed to be a core so you can have basic data. But you can easily imagine, BIM 360 Docs has additional data. For instance, it might have a pointer to documentation versus files. If you are using Docs, you probably know files and documentation differences.
So those data you can actually find as additional data to what A360 core provides. So you'll probably find a lot of information. Just sneak into [INAUDIBLE], which I'm planning to do later.
And model derivative API. This is an interesting one. Model derivative API is the ones you do so-called file translations. File translation is not language translation, it's about conversion. If you have-- I forgot which it was. But for instance, if you have IFC, you can actually read the IFC and then put the Revit file and then vise versa. So you can have five translations using this model derivative.
And thumbnails-- the model derivative API also allows you to create thumbnails and some type of geometric extraction. At this point, I think you can use OBJ files. So once you create the OBJ file, you can extract only the portion of it. So for instance, if you want to extract only the part of huge Revit file, it may be possible if you go through the model derivative process.
And then data extraction, this is about metadata or properties. So you can get all the properties you see in a property window in Revit, or View, or Windows. You can get this using model derivative APIs.
And with that, I want to move to my computer and then show some demo of a test harness. So my computer will make a big noise. So this is a kind of-- the image I showed in the PowerPoint is a little bit old, but this one is more or less the same thing.
So I made this one to start with as my own learning experience, and I found that it's actually a very good tool to tell you what it looks like when you start programming with Docs API. So I have this username and password, but this doesn't really do anything for Docs because they are not using this authentication, but you have 2-legged and 3-legged.
And let's say I have this 3-legged authentication, then you will see this page. This one is using 3-legged authentication and then Enter. Now I see the success. I didn't put that here.
And now these are the correction of the REST APIs. So for instance, if you have a project, you see this type of endpoint. So let's say hubs. In order to use hubs, you can have those possibilities, but you don't really need to have any parameters other than adding a token in a back end.
So if you run this one, you see this is a response, but this is a layered response, but it's a little bit difficult to read. So I put the tree view here. So this is a JSON format, a strict format to display the JSON.
And the reason why Autodesk is using is that if you just start discussing what format is good for everybody, by itself it's a little bit complicated. But apparently, in the cloud development community, this is a very common problem. So we are using this common JSON API format.
So JSON API, just JSON API is a button here, and links-- it's a set of links. So this is exactly what I was coding. And data-- so here is the ones you start seeing something interesting.
So I have four hubs. The first one is A. This is my personal hub, A360 hub, and I have other hubs. And the fourth one is actually my hub in Docs.
So, sorry, if you look at this hub, you see Autodesk 4G Pattern Development. And if you see Extensions, you see Hubs, Autodesk, BIM 360 Account. If I look at this first one, you extract this extension, you see this one, A360 Personal Hub. So by digging into this, you'll get the information. And there's another little small things, but it's actually-- it works.
You see this hub, my person hub has A here, and guess hub this will BIM-- it has to B. It has meaning. It has meaning. So if your ID start with B, you can assume it's starting with B. So you can do-- starting a comparison, you're ID.
And another demystifying thing. Now you see hubs ID B dot. If you want to BIM 360 admin page, and use BIM 360 HQ or the Admin API, they omitted this B dot. So this is another common question. I'm taking this hubs, and B, and hub ID, but it doesn't recognize in HQ, because HQ never worried about A360. So they didn't add this A or B. So this is another-- little tips and tricks from me.
So that's the hub ID. So now I want to see, sorry, I want to see the project. In order to see this list of projects, you use hubs, hub ID, and project.
Now you want the hub ID here, and this is a parameter. Orange is the must have URL parameters. So I made a copy from here to here. Just click in here and you run. Then you'll see a list of projects.
So I have seven projects. And for instance, I think first one is like ADN [INAUDIBLE] group hubs, and then I think second one is my demo. So for the demo image. This is the one I'm using, demo, so I don't mix up with other ones.
So for instance, this is my project and project ID. You see this line is starting with B dot. It's a project in BIM. If you use Team, it will show even though it's a BIM 360 Team. Historically, it's A, so it has A dot.
So once you have a project, what you want to do is a top folders account, project, and folders. So it used to be-- if you are with me for last year or so and you are looking at this again, this is one small thing that changed. It used to be a root folder, but root folder is only for other main purpose. So please use top folders. I think root folder is already duplicated. So this is one small change. If you have my old samples, then you probably need to change here.
So now I put the project ID here. Now I have the hub ID, and project ID, and run. Then I should see a lot of top folders. So this is a BIM 360 Docs folder. So I have a Plan here, and the BIM 360 Docs has Plan folders, and project files folder. So in this case, I'm looking at the folders here.
And now, once you get to the folders, you can go to contents. You can go to the service data, and there is contents. What content needs is project ID and folder. So you go to argument, and project ID's already here. So I put this folder ID here, and then run this REST code, and then you get this file name.
So this is about Docs Plan folder. You see a lot of documents and files. So in case you are not too familiar with BIM-- even though I kind of assumed you know-- so BIM 360 Plan folder is a specialized folder. It actually chops multiple seat documents. For instance, like a PDF, and Revit is actually a good example.
Revit has all the views, and if you put it in Plan folder, they actually chop-- I call it chop-- chops into each seat. So you see a lot of them. So in this folder, I'm actually seeing documents and then the files.
So for instance, let's say here, if you see this extension, it should say document. This is a chopped document, so like each page. And I already know 14 is actually a file, so this one is a file, sorry-- attribute, extensions. So this would be a file. So if you want to download a file, you check out reviewed extensions, and then you check if it's a file or not.
And another thing is trying to look for under included, because included has additional data, a special data. You usually find the more data. And once you get to, for instance, durations-- the included and go to relationship, you will see more information, such as items, links, [INAUDIBLE] here, derivative, thumbnails, and storage. So this is specialized data.
And for instance, if you want to download a data for this, then you can go to the storage, and then go to a metadata, and this is a call. You just need to call this one. Then it will download. If you want to have a thumbnail, you can also call this data a link, and you can access to the thumbnail. So you probably start seeing why we use these data on API with a big chunk of data, because it has a lot of data together with it.
And derivative is actually another interesting one, because derivative ID is the one you use to view it. So derivative ID-- I actually put that view up portion here. So you copy this derivative ID here. It's actually in the viewer. They call it URN.
And I need to copy this token. I'm just copying token for the [INAUDIBLE] side, because I need a token to go from the browser. So if you click on View, then you started to see the model. So for using a viewer, what you need is this URN and token. And other ones, other data you see before here, these are the ones you use to accessing data.
So these are the data management API. So once you get to a special file-- in this case, I access to this file, Revit file, familiar sample file-- and you want to do something with this using model derivative API, then you go to a model derivative API. Now you have a couple of different choices.
So for instance, in order to use metadata you need this URN. This is actually called this derivative ID. So you copy the one here, and then you run this REST API, then you get the data here.
So in order to use this method, data Glue ID, this is the data you want access to parameters like properties and metadata. So if you use this Glue ID here, now I have two parameters for here and here, and run.
Then you see a lot of data. Do you see here, object one? This is a data you see in hierarchy in a viewer. So for instance, you see object, flow art and things like that. This is a data you are seeing, model browser here. So you see the flow art here-- flow art, genetic. You should see exactly the same data on here. The generic 150, it's here.
So this data is returning this exact data, but you are actually accessing using API from here.
Now, as you can guess, if you use properties, you can probably guess what you can get. It has a lot of data, so it takes time. So now we have a model 600 properties. This is the data you actually seeing in these properties.
So for instance, I think 100 is the one-- maybe this one. This SG [INAUDIBLE] roof. This one has object ID 2209 here. This is the one. Actually, this one. See the basic [INAUDIBLE], I think, or maybe this.
One moment. I think I might have made a mistake. 2209. So you use this ID 2209 to access specific object. Actually, it's underneath, I think. You see this one highlighted? I think there is a layer here.
But as you can see, this one is-- one moment. This is a basic roof-- 22432. I forgot to return-- 243274. 101-- basic roof 101. So now I have to create it again.
So 101 is here. So this is a basic roof, and object ID 2201. So let's see. I just say Show All, Create a Selection. So I had to do-- was it 10? Yeah.
Yes.
So if I say 10 and forecast, then it should use 10. So this is how you associate with the viewable element versus your element. So you had to find the Revit element here, and you had to sort through this. But still, you can get the access.
So this is the basic two. And then I actually couldn't upload this app to the UI side, so I will give you the link. So I'm going back to my slide.
So BIM 360 Doc, there are certain-- in a basic workflow. As I keep saying it's more or less the same, but there are a couple of differences, and I already talked about this while showing a demo. So for instance, like A and B, this is one of the differences. And then also, if you are uploading, for instance, from BIM to BIM or to A360, then there is a slight difference, and those are the differences here.
If you are using BIM 360 Docs, you had to use BIM 360 Docs in upload locations, but if you are using A360 or even BIM 360 Team, then you will need to use a core. So you just have to be aware of those changes.
With the long instructions, only the small portion is saying this is different. We usually don't read it until we find it doesn't work. So those are the ones I just wanted to put up front.
And if you go to this developer overview basics, like a model derivative, there is a nice explanation there. It's just that since the documentation is too long, we usually delete it after we encounter the issue, at least that's what I do. Nobody reads instructions until you find out you don't understand.
So uploading a file is, for instance, in step one to six-- so here, for instance-- almost same. But last five and six, you just have to change this to BIM 360 from this core thing. So those minor things I just wanted to point out.
And then for the creation, this is another confusing thing. We waited for a long time for the creation. It's in a way, half way down, and we had to use this command right now to create a folder in Docs.
And to use a BIM one, we've been using it for a year or so for the post folders. But for now, for Docs, Docs has a lot of additional things you have to do, and it takes a little bit more time due to a lot of changes in the product as well. So just to be aware.
In long run, everything will go in a post too. We may still keep the command. We may still keep the command buttons, but it should be the same as the A360.
And you want to start, you as the developers, do you want to start? Did anybody feel like you want to start today? nobody?
If you are ADN members, just ask ADN normal channel. If you are not ADN members, then contact us. We will create to make it available for you. So first create a trial account, and then contact us, and we'll try to activate for long run-- not just 30 days, but long run.
And learn more, you'll probably see a lot of pages. Developer.Autodesk.com is always the starting point. And then I'm actually trying to write all those niche details in my blog after you. I've been quite busy with Revit automation, so I couldn't do it, but I will do this afterwards.
And there are a lot of samples. This is one. And when it comes to data management API getting started, this is a very good sample. So you can start this.
There are a lot of nice fancy samples, but since it's too fancy sometimes it's a little bit too much to start with. So my sample is the basics, but this is a very reasonable basic and a sophisticated basic. I always recommended that.
And then we already passed to some of the courses, but I'm just pointing out some of these courses that you may be interested in later. Or if it's past, you may want to see their handout or if there is a decoding. I think some of the ones over there is recorded. You may want to watch later.
And also, always catch us at the answer bar. Yes, so answer bar-- meet us at the answer bar. So contact us for future inquiries. Meet us at the answer bar while you are here. Grab me-- I'm wearing this, so grab me.
And then for after this week, I just wanted to point out-- so we use a [INAUDIBLE]. That's a very popular place to ask questions, and especially with the cloud-based ones, Autodesk's forum is not necessarily a great place to get advice about cloud. So we are actually moved there. So use that.
And then API product manager Tomer, he's really working hard for pushing a lot of our engineers. So if you have any high-level discussions, then Tomer would be the right person, and business-wise, Tom Culotta, he would be the right person. And any other business, like-- usually there is issues and things, it comes to me. I actually know this program more than what part works. So if you have any issues and want to solve it, send me-- I will definitely direct to my engineers and my team as well.
And then if you really get into development, you want to have a very quick one, and maybe by early next year, you convinced your company, your boss, and want to do something very quickly, then accelerator. So we have accelerator in San Francisco planned in the end of February, beginning of March. This is our intensive one week sitting together session. And it's quite hard, because you are in a room with engineers and you have to make progress, but this might be worth attending if you are interested in doing seriously very quickly.
And if you go to this site, and there is a place you can submit a proposal. It's not a training session. This is something like we want to spend our time to have wonderful apps coming quickly, rather than people just hitting heads and then give up. We just want to help to get started very quickly. So with that, any questions?
Oh, I just finished in time. Yeah.
AUDIENCE: [INAUDIBLE]
MIKAKO HARADA: As you could see, it's more or less the same. It's more or less the same, right? It's just the function is matched.
AUDIENCE: [INAUDIBLE]
MIKAKO HARADA: It's actually the same. So if you--
[APPLAUSE]
Thank you very much.
Downloads
Tags
Produkt | |
Branchen | |
Themen |