Project

Base definition

{
    "kind": "project",
    "id": string,
    "qualifiedReference": string,
    "scopedReference": string,
    "referenceId": string,
    "name": string,
    "url": string,
    "uri": string,
    "owner": {
        ...user.base // See user resource definition
    }
}

List definition

In addition to the base definition, any project resource returned by a list request will contain the following properties:

{
    "createdAt": integer, 
    "publicAccessLevel": string("none"|"view"),
    "studyAccessLevel": string("none"|"view") | null,
    "accessLevel": string("view"|"edit"),
    "study": {
        "kind": "study",
        "name": string
    } | null
}

Get definition

In addition to the base and list definition, any project resource returned by a get request will contain the following properties:

{
    "lastActive": integer,
    "tableCount": integer,
    "transformCount": integer,
    "notebookCount": integer,
    "description": string,
}

Documentation

Fields
Base
kind	string The resource type. Will always be "project"
id	string A unique, persistent identifier for the dataset.
qualifiedReference	string The fully qualified reference for the project, of the form username.project_reference. E.g., imathews.example_project_climate_analysis:x7kh
scopedReference	string The canonical reference for the project, e.g., example_project_climate_analysis:x7kh
referenceId	string A persistent, 4-character identifier for this project. Will always be unique across all projects owned by the user.
name	string The name of the project
url	string The project's url resolvable via the web interface.
uri	string The fully qualified URI of the project, for use in generating calls to this API. For example, /projects/imathews.example_project_climate_analysis:x7kh
owner	object The owner of the project. Will always be the User.base definition for the project's user.
List
createdAt	integer When the dataset was created. Stored as milliseconds since the epoch (1970-01-01).
publicAccessLevel	string The access level to the project for any user / all non-authenticated users. Will be one of "none"|"view" Users with access to a project will still only be able to see data derivatives that they have access to.
studyAccessLevel	string | null The access level to the project for any member of the project's study. If the project has a study, will be one of "none"|"view"|"edit". Otherwise, will be null.
accessLevel	string | null Your access level to the project. Will be one of "view"|"edit".
study	object | null This project's study
study.kind	string Will always be "study"
study.name	string The name of the study
Get
lastActive	integer When the project was last active, defined as a node in the project being run. Stored as milliseconds since the epoch (1970-01-01).
description	string A user-provided description of the dataset. Corresponds to the "abstract" show on the dataset overview.
tableCount	integer The number of tables created in the project.
transformCount	integer The number of transforms in the project.
notebookCount	integer The number of notebooks in the project