Document toolboxDocument toolbox

Project commands

GetProjectByID

Read details about a project.

Input

projectidnumberInternal Microbizz project ID

Output

projectscollection[project]An empty collection if the project wasn't found, or a collection with exactly one project

GetProjectActivityByID

Read details about a project activity.

Input

projectactivityidnumberInternal Microbizz project activity ID

Output

projectactivitiescollection[projectactivity]An empty collection if the project activity wasn't found, or a collection with exactly one project activity

GetProjectsByLastChange

Get a collection of projects changed since a given date and time.

Input

changedatedateReturn all projects changed on or after the provided date.
changetimetimeIf this is provided only return projects changed after the provided date and time.
resumekeystringIf a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries
ignoreclosedboolIf 1 then don't send projects that current user do not have access to


Output

projectscollection[project]A collection of the relevant projects, or an empty collection if no projects was found.
resumekeystringSometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results.


GetProjectActivitiesByLastChange

Get a collection of project activities changed since a given date and time.

Input

changedatedateReturn all project activities changed on or after the provided date.
changetimetimeIf this is provided only return project activities changed after the provided date and time.
resumekeystringIf a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries
ignoreclosedboolIf 1 then don't send project activities that current user do not have access to


Output

projectactivitiescollection[projectactivity]A collection of the relevant project activitys, or an empty collection if no project activities was found.
resumekeystringSometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results.

GetProjectsByField

Get a collection of projects where a given field matches a value.

Input

fieldstring

Return project where this field has the value specified in value.

Following output is possible by examples:


custom150

This will return a custom field with the ID 150


qref200

This will return a Microbizz field with the ID 200

valuestringReturn projects where the field specified in field has this value.
resumekeystring
include_closedboolean1 if closed tasks should be included.

Output

projectscollection[ Project ]A collection of the relevant projects, or an empty collection if no projects were found.
resumekeystringSometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results.

CreateUpdateProject

Creates or updates a project in Microbizz.

If the project provided has a project id of 0, a new project use will be created and a new project ID will be provided.

Input

projectprojectThe project to create/update


Output

projectprojectThe project object as it is in Microbizz after the update


CreateUpdateProjectActivity

Creates or updates a project activity in Microbizz.

If the project activity provided has a project activity id of 0, a new project activity use will be created and a new project activity ID will be provided.

Input

projectactivityprojectactivityThe project activity to create/update


Output

projectactivityprojectactivityThe project activity object as it is in Microbizz after the update

GetProjectTypes

Get all project types

Input

none--

Output

typescollection[ projecttype ]Collection of projecttype objects

GetProjectTemplates

Get all project templates

Input

none--

Output

typescollection[ projecttemplate ]Collection of project template objects

CreateProjectFromTemplate

Create a project from a template

Input

templateidnumberThe Microbizz ID of a template, see GetProjectTemplates
titlestringThe title of the project
customeridnumberThe Microbizz ID of a company
descriptionstringThe description of the project, this should be HTML
teamidnumberThe Microbizz ID of a team

Output

projectprojectThe newly created project