--- title: "GET /workbench/{WorkbenchId}" method: GET path: "/workbench/{WorkbenchId}" tags: ["Workbench"] --- # GET /workbench/{WorkbenchId} `GET /workbench/{WorkbenchId}` Retrieve the workbench information for the given workbench id ## Path parameters - `WorkbenchId` string, uuid, required ## Response `200` OK - Workbench — This schema contains information about the Workbench, the dependent variable or Primary Indicator of the workbench under the Indicator subschema, and independent variables or Explanatory Indicators in the WorkbenchIndicator subschema. - `id` string, uuid — The id of the workbench. - `name` string, nullable — The name of the workbench. - `description` string, nullable — The description of the workbench. - `created` string, date-time — The timestamp in UTC for when the workbench was created. - `owner` string, nullable — The username of the owner of the workbench. - `lastModified` string, date-time — The timestamp in UTC when the workbench was last saved. - `frequency` string, nullable — The frequency of the workbench in string format. - `calculation` string, nullable — The calculation of the workbench in string format. - `primaryIndicator` Indicator - `id` string, uuid - `name` string, nullable - `description` string, nullable - `aggregate` 0 | 1 | 2 | 3 | 4 | 5 | 6 - `calculation` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — The transformation applied to the data. Possible options: None 1 PeriodOverPeriod 2 YearOverYear 3 ThreePeriodYearOverYear 6 - `color` string, nullable - `displayInformation` DisplayInformation - `name` string, nullable — The display name to be used in the application. Limited to 50 characters. - `description` string, nullable — The description to be shown in the application. Limited to 1,000 characters. - `color` string, nullable — The color to use in the application. Must be a valid hex color code. - `category` string, nullable — The category of the indicator. Limited to 1,000 characters. - `count` integer - `created` string, date-time - `startTime` string, date-time, nullable - `endTime` string, date-time, nullable - `transformedStartTime` string, date-time, nullable - `transformedEndTime` string, date-time, nullable - `frequency` 0 | 1 | 2 | 4 | 12 | 52 | 365 | 1000 — The frequency of the data. Daily: 365 Weekly: 52 Monthly: 12 Quarterly: 4 SemiAnnual: 2 Annual: 1 - `deprecated` boolean - `deprecationReason` string, nullable - `lastModified` string, date-time - `provider` Provider - `name` string, nullable - `description` string, nullable - `id` string, uuid - `source` string, nullable - `providerId` string, nullable - `seasonality` 0 | 1 | 999 - `source` string, nullable - `classification` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `tags` string[], nullable - `type` string, nullable - `units` string, nullable - `accessibility` 0 | 1 | 2 - `periodAlignment` 0 | 1 | 2 - `path` string, nullable - `notes` string, nullable - `citation` string, nullable - `dataSources` IndicatorDataSource[], nullable - `name` string, nullable - `url` string, nullable - `dataSourceType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 - `industryCodes` IndustryCode[], nullable - `type` string, nullable - `code` string, nullable - `hasZeroVariance` boolean, nullable - `interval` string, nullable - `countryCode` string, nullable - `indicators` WorkbenchIndicator[], nullable — A list of the indicators that are in the workbench. Includes hidden indicators as well. - `indicator` Indicator - `id` string, uuid - `name` string, nullable - `description` string, nullable - `aggregate` 0 | 1 | 2 | 3 | 4 | 5 | 6 - `calculation` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — The transformation applied to the data. Possible options: None 1 PeriodOverPeriod 2 YearOverYear 3 ThreePeriodYearOverYear 6 - `color` string, nullable - `displayInformation` DisplayInformation - `name` string, nullable — The display name to be used in the application. Limited to 50 characters. - `description` string, nullable — The description to be shown in the application. Limited to 1,000 characters. - `color` string, nullable — The color to use in the application. Must be a valid hex color code. - `category` string, nullable — The category of the indicator. Limited to 1,000 characters. - `count` integer - `created` string, date-time - `startTime` string, date-time, nullable - `endTime` string, date-time, nullable - `transformedStartTime` string, date-time, nullable - `transformedEndTime` string, date-time, nullable - `frequency` 0 | 1 | 2 | 4 | 12 | 52 | 365 | 1000 — The frequency of the data. Daily: 365 Weekly: 52 Monthly: 12 Quarterly: 4 SemiAnnual: 2 Annual: 1 - `deprecated` boolean - `deprecationReason` string, nullable - `lastModified` string, date-time - `provider` Provider - `name` string, nullable - `description` string, nullable - `id` string, uuid - `source` string, nullable - `providerId` string, nullable - `seasonality` 0 | 1 | 999 - `source` string, nullable - `classification` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `tags` string[], nullable - `type` string, nullable - `units` string, nullable - `accessibility` 0 | 1 | 2 - `periodAlignment` 0 | 1 | 2 - `path` string, nullable - `notes` string, nullable - `citation` string, nullable - `dataSources` IndicatorDataSource[], nullable - `name` string, nullable - `url` string, nullable - `dataSourceType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 - `industryCodes` IndustryCode[], nullable - `type` string, nullable - `code` string, nullable - `hasZeroVariance` boolean, nullable - `interval` string, nullable - `countryCode` string, nullable - `offset` integer — The offset applied to the indicator in the workbench. - `sort` integer — The overall sort position of the indicator in the workbench. - `locked` boolean — If the indicator is locked in the workbench. - `visible` boolean — If the indicator is visible in the workbench. - `isLoggable` boolean — If the indicator series trimmed to the workbench's dates are loggable. - `incompatible` boolean — If the indicator is compatible with the workbench's selected calculation and frequency. - `correlation` IndicatorCorrelation - `correlationCoefficient` number, double - `rSquared` number, double - `proCyclic` number, double - `counterCyclic` number, double - `expectedSign` string, nullable — The user defined expected sign of the indicator in relation to the primary. Current values: Unspecified, Positive, Negative - `transformations` Transformation[], nullable — The transformations applied to the indicator in the workbench. - `order` integer - `required` boolean - `categories` WorkbenchCategoryInfo[], nullable — A list of the categories that are in the workbench. - `id` string, uuid - `name` string, nullable - `sort` integer - `note` string, nullable - `indicators` IndicatorKey[], nullable - `provider` string, uuid — The ID of the provider for the indicator. - `providerId` string, nullable — The provider id of the indicator. - `tags` string[], nullable — A list of tags that are assigned to the workbench. - `cutoffDate` string, date-time, nullable — The cut off date of the workbench. This is used to front trim the workbench's dependent and independent variables. - `calculatedStartDate` string, date-time — The calculated common start date of the workbench. - `endDate` string, date-time, nullable — The cut off end date of the workbench. - `url` string, nullable — The url of the workbench. - `notes` string, nullable — The notes of the workbench. - `notesLastModified` string, date-time, nullable — The last modified date of the notes of the workbench. ## Other responses - `400` — Bad Request - `404` — Not Found - `429` — If the user has sent too many requests --- [API](https://skmtc.net/prevedere/apis/board-foresight-api-v1.md) · [All operations](https://skmtc.net/prevedere/apis/board-foresight-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prevedere/board-foresight-api-v1/revisions/c5ac8232e334/schema)