API Reference

/organizations/{organization_id}/sites/{site_id}/workspaces/{workspace_id}/shapes/{shape_id}/widgets/{widget_id}/calculate

post
https://api.propelleraero.com/v1/organizations//sites//workspaces//shapes//widgets//calculate

Creates a job to calculate the properties of the widget. Subsequent identical requests will either return the job status, or the result data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the organization

string
required

ID of the site

string
required

ID of the workspace

string
required

ID of the shape

string
required

ID of the widget

Body Params
string

The dataset ID to be used for the calculation. This is required by most site-level shapes to resolve surfaces. The dataset for the shape will be preferred over the dataset ID provided here.

date-time

The timestamp for the calculation, if applicable. Format should be ISO 8601. Timestamp can be optionally provided for DirtMate sites only, otherwise, this value should be omitted. When provided the calculation will include DirtMate data and set the time of the primary surface.

Responses

Updated 15 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago