WorkspaceDetail
A workspace with the saved elements it contains, in lists by kind. A list excluded by the type filter of the operation is omitted.
Identifier of the workspace. Use it as {workspaceId} in the workspace operations.
Name of the workspace. It is not unique.
Code of the survey currently active in the workspace. Empty string when none.
Name of the survey currently active in the workspace. Empty string when none. Under /api/v2 it is the caller's alias for the survey, or the catalog name when there is no alias. When that name cannot be resolved, it is the name saved with the workspace: in GET /api/v2/workspaces, when the survey is no longer available to the caller; in GET /api/v2/workspace/{workspaceId}, when the survey is not among surveys.
Creation date and time of the workspace, ISO 8601 with a UTC offset.
Date and time of the last update of the workspace, ISO 8601 with a UTC offset. Omitted when the workspace was never updated. Returned only by the workspace list.
Whether the caller owns the workspace and whether it is shared. A workspace shared with the caller is read only. Returned only by the workspace list.
| Enum Value | Description |
|---|---|
| OWN | Owned by the caller and not shared with other users. |
| SHARED_BY_ME | Owned by the caller and shared with other users. |
| SHARED_WITH_ME | Owned by another user and shared with the caller. Read only: only the owner can create, edit or delete its elements. |
Possible values: [OWN, SHARED_BY_ME, SHARED_WITH_ME]
Name of the user who owns the workspace. Only when ownership is SHARED_WITH_ME. Returned only by the workspace list.
tabulations object[]
Saved tabulations of the workspace. Omitted when excluded by type.
Identifier of the element. Use it as {elementId} in GET /api/v2/workspace/{workspaceId}/element/{elementId}.
Name of the element.
Creation date and time of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
Date and time of the last update of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
targets object[]
Saved targets of the workspace. Omitted when excluded by type.
Identifier of the element. Use it as {elementId} in GET /api/v2/workspace/{workspaceId}/element/{elementId}.
Name of the element.
Creation date and time of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
Date and time of the last update of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
userVars object[]
User variables of the workspace. Omitted when excluded by type.
Identifier of the element. Use it as {elementId} in GET /api/v2/workspace/{workspaceId}/element/{elementId}.
Name of the element.
Creation date and time of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
Date and time of the last update of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
reachTables object[]
Saved Reach tables of the workspace. Omitted when excluded by type.
Identifier of the element. Use it as {elementId} in GET /api/v2/workspace/{workspaceId}/element/{elementId}.
Name of the element.
Creation date and time of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
Date and time of the last update of the element, in UTC, ISO 8601 with a +00:00 offset. It can be an empty string when it is not known.
surveys object[]
Surveys of the workspace, including the ones the caller can no longer query. availableReach is not included. Omitted when no survey is attached.
Code of the survey. Use it as {surveyCode} in the survey operations.
Name of the survey to show. Under /api/v2 it is the caller's alias for the survey (their own, or else the default one) and the catalog name when there is no alias. It is not unique and can change: identify surveys by code. The catalog name is in originalDescription.
Catalog name of the survey, without any alias. Use description to show the survey and this field to classify or search it. Only returned by the operations under /api/v2.
Creation date and time of the survey, ISO 8601 with a UTC offset. It can be an empty string when it is not known.
Date and time of the last update of the survey, ISO 8601 with a UTC offset. It can be an empty string when it is not known.
Whether the survey supports Reach tables (it is built on a consumption diary). Only returned by GET /api/v2/users/surveys.
weights object[]
Weightings of the survey, in the platform's order. The default one has isDefault: true. Empty when the survey has none. Only returned by GET /api/v2/users/surveys.
Identifier of the weighting.
Name of the weighting, as the survey defines it. It is not translated.
Universe of the weighting. It can be missing.
Whether it is the default weighting of the survey, the one used when a table is sent without a weighting.
{
"id": "string",
"name": "string",
"surveyCode": "string",
"surveyDescription": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z",
"ownership": "OWN",
"ownerName": "string",
"tabulations": [
{
"id": "string",
"name": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"updateDate": "2024-07-29T15:51:28.071Z"
}
],
"targets": [
{
"id": "string",
"name": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"updateDate": "2024-07-29T15:51:28.071Z"
}
],
"userVars": [
{
"id": "string",
"name": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"updateDate": "2024-07-29T15:51:28.071Z"
}
],
"reachTables": [
{
"id": "string",
"name": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"updateDate": "2024-07-29T15:51:28.071Z"
}
],
"surveys": [
{
"code": "string",
"description": "string",
"originalDescription": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"updatedDate": "2024-07-29T15:51:28.071Z",
"availableReach": true,
"weights": [
{
"id": "string",
"label": "string",
"universe": 0,
"isDefault": true
}
]
}
]
}