Assets
| API | Description |
|---|---|
| POST api/v{version}/Assets |
Creates a new asset. |
| GET api/v{version}/Assets |
Gets all assets in the user's current project. |
| GET api/v{version}/Assets?id={id} |
Gets the asset with the given ID. |
| GET api/v{version}/Assets?identifier={identifier} |
Gets the asset with the given identifier. |
| POST api/v{version}/Assets/Update |
Updates an asset. |
| GET api/v{version}/Assets/Delete?id={id} |
Deletes an asset. |
ForecastPoints
| API | Description |
|---|---|
| GET api/v{version}/ForecastPoints?id={id} |
Gets the forecast point with the given ID. |
| GET api/v{version}/ForecastPoints |
Gets the forecast points for the current project. |
| GET api/v{version}/ForecastPoints/LastUpdate?id={id} |
Gets the last time that the forecast was updated. |
Projects
| API | Description |
|---|---|
| GET api/v{version}/Projects |
Gets a list of projects to which the user has access. |
| GET api/v{version}/Projects?id={id} |
Gets the project with the given ID. |
| GET api/v{version}/Projects?identifier={identifier} |
Gets the project with the given identifier. |
TransitStageDurations
Variables
| API | Description |
|---|---|
| GET api/v{version}/Variables |
Gets the variables for a project. |
| GET api/v{version}/Variables?id={id} |
Gets the variable with the given ID. |
| GET api/v{version}/Variables?name={name} |
Gets the variable with the given name. |
TransferPlans
| API | Description |
|---|---|
| GET api/v{version}/TransferPlans?id={id} |
Gets the transfer plan with the given ID. |
| GET api/v{version}/TransferPlans?minStart={minStart}&maxStart={maxStart} |
Gets a list of transfer plans for the current project. |
| POST api/v{version}/TransferPlans |
Creates a transfer plan in the user's current project. |
| GET api/v{version}/TransferPlans/GenerateStartTimes?id={id}&vesselId={vesselId}&maxStart={maxStart} |
Generates possible start times for a transfer plan within the current forecast range. Generated start times are 'on the hour'. |
| GET api/v{version}/TransferPlans/GenerateScheduleImageId?id={id}&vesselId={vesselId}&start={start} |
Generates a new image of a transfer plan schedule, archives it for later use, and returns its ID. |
| GET api/v{version}/TransferPlans/GenerateScheduleImage?id={id}&vesselId={vesselId}&start={start} |
Generates and returns new image of a transfer plan schedule along with its ID. Archives the schedule image for later use. |
| GET api/v{version}/TransferPlans/ScheduleImages?id={id} |
Gets a previously generated image of a transfer plan schedule from the archive. |
| GET api/v{version}/TransferPlans/Update?id={id}&start={start} |
Updates the start date of a transfer plan. |
| POST api/v{version}/TransferPlans/Update?operationId={operationId} |
Replaces the existing stage durations of a transfer plan operation with another set of stage durations. |
| POST api/v{version}/TransferPlans/Update?updateDetailsOnly={updateDetailsOnly} |
Updates a transfer plan. |
| GET api/v{version}/TransferPlans/Delete?id={id} |
Deletes a transfer plan. |
Vessels
Handles API requests to get or change the vessels that are used for transfer planning.
| API | Description |
|---|---|
| GET api/v{version}/Vessels |
Gets all vessels in the user's current project. |
| GET api/v{version}/Vessels?identifier={identifier} |
Gets the vessel with the given identifier. |
| GET api/v{version}/Vessels?id={id} |
Gets the vessel with the given ID. |
| POST api/v{version}/Vessels |
Creates a vessel in the user's current project. |
| POST api/v{version}/Vessels/Update?updateDetailsOnly={updateDetailsOnly} |
Updates a vessel. |
| POST api/v{version}/Vessels/Update?thresholdsGroupId={thresholdsGroupId} |
Replaces the existing thresholds of a vessel thresholds group with another set of thresholds. |
| GET api/v{version}/Vessels/Delete?id={id} |
Deletes a vessel. |
| GET api/v{version}/Vessels/GenerateWeatherWindows?vesselId={vesselId}&assetId={assetId}&date={date} |
Generates the weather windows for the given vessel at the given asset on the given day. Weather windows are based on deterministic data only. |
| GET api/v{version}/Vessels/GenerateWeatherWindowsImage?vesselId={vesselId}&assetIds[0]={assetIds[0]}&assetIds[1]={assetIds[1]}&date={date} |
Generates the weather windows image for the given vessel at the given assets on the given day. Weather windows are based on deterministic data only. |
| GET api/v{version}/Vessels/GetWeatherData?vesselId={vesselId}&assetIds[0]={assetIds[0]}&assetIds[1]={assetIds[1]}&date={date} |
Gets the deterministic weather data at the given assets on the given day for the metocean conditions to which the given vessel is sensitive. |
OperationTemplates
| API | Description |
|---|---|
| GET api/v{version}/OperationTemplates |
Gets a list of operation templates that are available in the current project. An operation template is a common type of task, such as transferring crew to a turbine. |
| GET api/v{version}/OperationTemplates?id={id} |
Returns the operation template with the given ID. An operation template is a common type of task, such as transferring crew to a turbine. |