Skip to main content

Workspace

A workspace of the user: its id, name, active survey and creation date. The workspace list also returns its last update and who owns it.

idstring

Identifier of the workspace. Use it as {workspaceId} in the workspace operations.

namestring

Name of the workspace. It is not unique.

surveyCodestring

Code of the survey currently active in the workspace. Empty string when none.

surveyDescriptionstring

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.

creationDatestring<date-time>

Creation date and time of the workspace, ISO 8601 with a UTC offset.

lastUpdatedstring<date-time>

Date and time of the last update of the workspace, ISO 8601 with a UTC offset. A workspace that was never updated also has it, set when the workspace was created; it is omitted only in some older workspaces. Returned only by the workspace list.

ownershipWorkspaceOwnership (string)

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 ValueDescription
OWNOwned by the caller and not shared with other users.
SHARED_BY_MEOwned by the caller and shared with other users.
SHARED_WITH_MEOwned 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]

ownerNamestring

Name of the user who owns the workspace. Only when ownership is SHARED_WITH_ME. Returned only by the workspace list.

Workspace
{
"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"
}