Project commands

Project commands

GetProjectByID

Read details about a project.

Input

projectid

number

Internal Microbizz project ID

Output

projects

collection[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

projectactivityid

number

Internal Microbizz project activity ID

Output

projectactivities

collection[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

changedate

date

Return all projects changed on or after the provided date.

changetime

time

If this is provided only return projects changed after the provided date and time.

resumekey

string

If a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries

ignoreclosed

bool

If 1 then don't send projects that current user do not have access to



Output

projects

collection[project]

A collection of the relevant projects, or an empty collection if no projects was found.

resumekey

string

Sometimes 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

changedate

date

Return all project activities changed on or after the provided date.

changetime

time

If this is provided only return project activities changed after the provided date and time.

resumekey

string

If a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries

ignoreclosed

bool

If 1 then don't send project activities that current user do not have access to



Output

projectactivities

collection[projectactivity]

A collection of the relevant project activitys, or an empty collection if no project activities was found.

resumekey

string

Sometimes 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



field

string

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

value

string

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

resumekey

string



include_closed

boolean

1 if closed tasks should be included.

Output



projects

collection[ Project ]

A collection of the relevant projects, or an empty collection if no projects were found.

resumekey

string

Sometimes 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

project

project

The project to create/update



Output

project

project

The 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

projectactivity

projectactivity

The project activity to create/update



Output

projectactivity

projectactivity

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

GetProjectTypes

Get all project types

Input

none

-

-

Output

types

collection[ projecttype ]

Collection of projecttype objects

GetProjectTemplates

Get all project templates

Input

none

-

-

Output

types

collection[ projecttemplate ]

Collection of project template objects

CreateProjectFromTemplate

Create a project from a template

Input

templateid

number

The Microbizz ID of a template, see GetProjectTemplates

title

string

The title of the project

customerid

number

The Microbizz ID of a company

description

string

The description of the project, this should be HTML

teamid

number

The Microbizz ID of a team

Output

project

project

The newly created project