static osapi.jive.corev3.projects

Static class for getting and creating Projects. A Project is a place for keeping track of progress on a work-related project. Projects can have Tasks and Checkpoints. To add a task to a Project, call createTask on a Project object. To create checkpoints, call setCheckpoints and supply a list of names and due dates.

Methods

↑
create(project,options)
POST /places

Retrieves

Project

Description

Create a new project.

Here is an example of a JSON with the minimum set of fields you must include: 

{
    "displayName": "To_infinity_and_beyond",
    "name": "Mars Project",
    "parent" : "https://example.jiveon.com/api/core/v3/places/1435",
    "startDate" : "2012-06-25T23:29:00.000+0000",
    "dueDate" : "2012-09-25T23:29:00.000+0000"
}

Takes:
  • Project Description of the project to be created.
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned.
Retrieves:
  • Project Representation of the newly created project
    • ↑
    create(project,options)
    POST /places/{uri}/contents

    Retrieves

    Project

    Description

    Create a new project.

    Here is an example of a JSON with the minimum set of fields you must include: 

    {
    "displayName": "To_infinity_and_beyond",
    "name": "Mars Project",
    "parent" : "https://example.jiveon.com/api/core/v3/places/1435",
    "startDate" : "2012-06-25T23:29:00.000+0000",
    "dueDate" : "2012-09-25T23:29:00.000+0000"
}

    Takes:
    • Project Description of the project to be created.
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned.
    Retrieves:
  • Project Representation of the newly created project
    • ↑
    get(options)
    GET /places

    Retrieves

    Place[]

    Description

    Return a paginated list of projects that match the specified criteria.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of places to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    searchStringfalseOne or more search terms separated by commas, limiting results to places that match the terms. Wildcards can be used, e.g. to search by substring use "*someSubstring*".
    startIndexIntegerfalseZero-relative index of the first place to be returned
    tagStringfalseComma delimited list of tag values, limiting results to places with one of those tags
    Retrieves:
  • Project[] Paginated list of matching projects
    • ↑
    get(options)
    GET /places/{uri}

    Retrieves

    Place

    Description

    Return a single project by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the project to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Project Representation of the requested project