PRprevedere
Workbench

GET /workbench/{WorkbenchId}

Retrieve the workbench information for the given workbench id

Request

  • Base URL
    https://api.prevedere.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.prevedere.com/workbench/{WorkbenchId}
  • Auth
    API key in query parameter ApiKey

Path parameters

WorkbenchIdstring uuid required

Response

OK

idstring uuid

The id of the workbench.

namestring nullable

The name of the workbench.

descriptionstring nullable

The description of the workbench.

createdstring date-time

The timestamp in UTC for when the workbench was created.

ownerstring nullable

The username of the owner of the workbench.

lastModifiedstring date-time

The timestamp in UTC when the workbench was last saved.

frequencystring nullable

The frequency of the workbench in string format.

calculationstring nullable

The calculation of the workbench in string format.

tagsstring[] nullable

A list of tags that are assigned to the workbench.

cutoffDatestring date-time nullable

The cut off date of the workbench. This is used to front trim the workbench's dependent and independent variables.

calculatedStartDatestring date-time

The calculated common start date of the workbench.

endDatestring date-time nullable

The cut off end date of the workbench.

urlstring nullable

The url of the workbench.

notesstring nullable

The notes of the workbench.

notesLastModifiedstring date-time nullable

The last modified date of the notes of the workbench.

Changes

No recorded changes to this operation across all 2 revisions of this API.