Project

Project

Description

This object is a representation of a project: it contains saved searches, saved results, and saved assessments.

Fields

Parameter Name	Type	Description
id	string	the project ID
ownerID	string	the owner of this project.
name	string	the name of this project.
isDefault	boolean	whether the project is the user's default project.
externalID	string	Optional: the external id of the project.
savedSearches	List of SavedSearch objects	Optional: See description of SavedSearch.
savedResults	SavedResults object	Optional: See description of SavedResults.
assessments	Assessments object	Optional: saved assessments for this project.
shares	Shares object	Optional: See description of Shares.
version	integer	The modification number of the project (used for checking if project is up to date).
isShared	boolean	whether the project is shared with the user (otherwise it is owned by the user).
isReadOnly	boolean	whether the project is shared as read-only project.

Examples

{
    "id": "d40b054ce1a14d73bd6cbef1428e46f1",
    "name": "My Project",
    "ownerID": "user2",
    "isDefault": false,
    "savedSearches": [ ... ],
    "savedResults": {
        "projectID": "d40b054ce1a14d73bd6cbef1428e46f1",
        "searcherResults": { ... }
    },
    "assessments": {
        "searcherAssessments": { ... }
    },
    "shares": { ... },
    "version": 3,
    "isShared": true,
    "isReadOnly": false
}