/projects

This is an extension of the Project Api. There are currently 3 different types of Projects:

Table of Contents #

GET /projects #

Gets all projects the current user has access to.

It will show projects that the user owns and those which has been shared to. Each ProjectData entry will have information about who owns the project and what access the current user has.

Request

GET projects
GET projects/{projectType}/

Parameters

projectType (optional) : Optionally restricts the response to projects of only one kind. If left empty, projects of all types will be returned. Valid project types are:

Response

Example: The api request https://api.silobreaker.com/projects/Scrapbook?type=json will produce output similar to:

{
    Projects: [
        {
            UserName: "halif",
            OwnerDisplayName: "halif",
            ProjectRef: "15_2772",
            ProjectType: "Scrapbook",
            Description: "newcollection",
            WriteAccess: true
            ShareState: "collaborative",
        }
    ],
    LastUpdated: "0001-01-01T00:00:00"
}

GET /projects/withitem #

Gets all projects containing a certain item.

This endpoint is useful for doing reverse lookup from for example an entity to the entity lists containing it.

Request

GET /projects/withitem

Parameters

itemRef (required) : The id of the item. An id has the following format 11_240886.

Response

Example: This api request projects/withitem?itemRef=11_240886&type=json will produce

{
    "Projects": [
        {
            "UserName": "alice",
            "OwnerDisplayName": "Alice",
            "ProjectRef": "15_1234",
            "ProjectType": "EntityList",
            "Description": "Secret Communications",
            "WriteAccess": true
        }
    ],
    "LastUpdated": "0001-01-01T00:00:00"
}

Documentation generated by mdoc.