Workspace ServicesΒΆ

These services provide access to information about workspaces that Scale uses to manage files.

Workspace List
Returns a list of all workspaces.
GET /workspaces/
Query Parameters
page Integer Optional The page of the results to return. Defaults to 1.
page_size Integer Optional The size of the page to use for pagination of results. Defaults to 100, and can be anywhere from 1-1000.
started ISO-8601 Datetime Optional The start of the time range to query. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
ended ISO-8601 Datetime Optional End of the time range to query, defaults to the current time. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
name String Optional Return only workspaces with a given name. Duplicate it to filter by multiple values.
order String Optional One or more fields to use when ordering the results. Duplicate it to multi-sort, (ex: order=name&order=title). Prefix fields with a dash to reverse the sort, (ex: order=-name).
Successful Response
Status 200 OK
Content Type application/json
JSON Fields
count Integer The total number of results that match the query parameters.
next URL A URL to the next page of results.
previous URL A URL to the previous page of results.
results Array List of result JSON objects that match the query parameters.
.id Integer The unique identifier of the model. Can be passed to the details API call. (See Workspace Details)
.name String The stable name of the workspace used for queries.
.title String The human readable display name of the workspace.
.description String A longer description of the workspace.
.base_url String The URL prefix used to access all files within the workspace. This field can be null if the workspace is not web-accessible.
.is_active Boolean Whether the workspace is active (false once workspace is archived).
.used_size Decimal The amount of disk space currently being used by the workspace in bytes. This field can be null if the disk space is unknown.
.total_size Decimal The total amount of disk space provided by the workspace in bytes. This field can be null if the disk space is unknown.
.created ISO-8601 Datetime When the associated database model was initially created.
.archived ISO-8601 Datetime When the workspace was archived (no longer active).
.last_modified ISO-8601 Datetime When the associated database model was last saved. 
{
    "count": 5,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 2,
            "name": "products",
            "title": "Products",
            "description": "Products Workspace",
            "base_url": "http://host.com/products",
            "is_active": true,
            "used_size": 0,
            "total_size": 0,
            "created": "2015-10-05T21:26:04.876Z",
            "archived": null,
            "last_modified": "2015-10-05T21:26:04.876Z"
        },
        {
            "id": 1,
            "name": "rs",
            "title": "Raw Source",
            "description": "Raw Source Workspace",
            "base_url": "http://host.com/rs",
            "is_active": true,
            "used_size": 0,
            "total_size": 0,
            "created": "2015-10-05T21:26:04.855Z",
            "archived": null,
            "last_modified": "2015-10-05T21:26:04.855Z"
        },
        ...
    ]
}
Workspace Details
Returns workspace details
GET /workspaces/{id}/
Where {id} is the unique identifier of an existing model.
Successful Response
Status 200 OK
Content Type application/json
JSON Fields
id Integer The unique identifier of the model.
name String The stable name of the workspace used for queries.
title String The human readable display name of the workspace.
description String A longer description of the workspace.
base_url String The URL prefix used to access all files within the workspace. This field can be null if the workspace is not web-accessible.
is_active Boolean Whether the workspace is active (false once workspace is archived).
used_size Decimal The amount of disk space currently being used by the workspace in bytes. This field can be null if the disk space is unknown.
total_size Decimal The total amount of disk space provided by the workspace in bytes. This field can be null if the disk space is unknown.
created ISO-8601 Datetime When the associated database model was initially created.
archived ISO-8601 Datetime When the workspace was archived (no longer active).
last_modified ISO-8601 Datetime When the associated database model was last saved.
json_config JSON Object JSON configuration with attributes specific to the type of workspace. (See Workspaces) 
{
    "id": 1,
    "name": "rs",
    "title": "Raw Source",
    "description": "Raw Source Workspace",
    "base_url": "http://host.com/rs",
    "is_active": true,
    "used_size": 0,
    "total_size": 0,
    "created": "2015-10-05T21:26:04.855Z",
    "archived": null,
    "last_modified": "2015-10-05T21:26:04.855Z"
    "json_config": {...}
}