Practitioner ⭐️

Solved

Learn Interactive engineering diagrams

20 replies
351 views

https://docs.cognite.com/cdf/integration/guides/contextualization/interactive_diagrams

How to create engineering diagram, and How get label name in diagram “23-LAHH-96138” through JavaScript.

Lars MoastuenAnswer

Expert ⭐️⭐️⭐️⭐️

Please see https://docs.cognite.com/api/v1/#tag/Engineering-diagrams for details on the API for engineering diagrams. The JavaScript SDK doesn’t have dedicated endpoints for this API as its rarely used with Javascript, but it can be accessed using generic REST API functionality in CogniteClient, e.g. https://cognitedata.github.io/cognite-sdk-js/classes/cogniteclient.html#post.

Note that we do not have a dedicated file viewer component in place at this time, so you will need to write a custom document viewer on your own.

Lars Moastuen (Software Engineer, Atlas AI)

Lars MoastuenAnswer

Expert ⭐️⭐️⭐️⭐️

Please see https://docs.cognite.com/api/v1/#tag/Engineering-diagrams for details on the API for engineering diagrams. The JavaScript SDK doesn’t have dedicated endpoints for this API as its rarely used with Javascript, but it can be accessed using generic REST API functionality in CogniteClient, e.g. https://cognitedata.github.io/cognite-sdk-js/classes/cogniteclient.html#post.

Note that we do not have a dedicated file viewer component in place at this time, so you will need to write a custom document viewer on your own.

Lars Moastuen (Software Engineer, Atlas AI)

K

Karthik KaliyaperumalAuthor

Practitioner ⭐️

How to preview file in javascript

Lars Moastuen

Expert ⭐️⭐️⭐️⭐️

Hi Karthik. As mentioned above, we do not currently have a dedicated file viewer component. You can use https://docs.cognite.com/api/v1/#tag/Engineering-diagrams/operation/diagramConvertResults to generate an image (PNG or SVG) with annotations, but any interactions must be handled manually.

Lars Moastuen (Software Engineer, Atlas AI)

K

Karthik KaliyaperumalAuthor

Practitioner ⭐️

ok thanks

K

Karthik KaliyaperumalAuthor

Practitioner ⭐️

I need exact job id, please tell how to find job id ?

judekumar87

Practitioner ⭐️⭐️⭐️

Hi Karthik. You are referring to the wrong job id. The job id in the file metadata is not relevant here.

/api/v1/projects/{{project}}/context/diagram/convert/:jobId

The above endpoint will get you the results for converting an engineering diagram to an image. In order to use the above endpoint you should have already submitted a convert job via the below endpoint which will in return give you a jobId which you will be able to use with the above endpoint.

/api/v1/projects/{{project}}/context/diagram/convert

For more information on the endpoints you can always refer to our documentation.

K

Karthik KaliyaperumalAuthor

Practitioner ⭐️

ok, Thank

Hi Karthik. You are referring to the wrong job id. The job id in the file metadata is not relevant here.

/api/v1/projects/{{project}}/context/diagram/convert/:jobId

The above endpoint will get you the results for converting an engineering diagram to an image. In order to use the above endpoint you should have already submitted a convert job via the below endpoint which will in return give you a jobId which you will be able to use with the above endpoint.