REST and URI

PolyWorks|DataLoop API allows you to access PolyWorks|DataLoop data by using HTTPS/REST principles. This page provides an architectural view of the endpoints exposed in PolyWorks|DataLoop Core 2024 or later versions.

The URL used to access endpoints should always be constructed according to the following template:

https://{Fully qualified domain name}/dataloopcore/api/metrology/v2/{ResourceName}/{UniqueIdentifier}

The items of the template should respect the criteria below:

• ResourceName - corresponds to the data entities that are exposed in the PolyWorks|DataLoop API (see below)
• UniqueIdentifier - an optional GUID if the unique identifier of a precise resource is known in advance

Available resource hierarchy

This diagram offers an abstract view of what is currently available beneath the surface. The name of the resource is seen in the top portion.

More information is available through the Swagger/OpenAPI descriptions, which can be accessed either via:

• The PolyWorks|DataLoop API Reference section of this site
• GET https://_example.com_/dataloopcore/api/metrology/openapi endpoint

📘

OData

For more information about OData and OData2 mean in the diagram above, please see Flexible Navigation (OData). Those refer to the parameters that can be used on the HTTP query string to control the JSON output (they are represented with metaclass semantic instead of a sub-type because it is not part of the request body).

🚧

About Security

All PolyWorks|DataLoop API access requires the user to be authenticated and authorized with OAuth security tokens. Please refer to the Authentication and Authorization (OAuth) for more information.