Document toolboxDocument toolbox

Production commands

AddProduction

Consider using CreateUpdateProductionByID.

Add some work to the production plan in Microbizz. The work is added without checking for overlap and workplan collisions.

Even though the id field is ignored, it must be provided in the prodplanentry object.

Input

prodplanentryprodplanentryThe entry to add to the production plan.

Output

prodplanentryprodplanentryThe newly created prodplanentry

CreateUpdateProductionByID

Add, or edit, some work to the production plan in Microbizz. The work is added without checking for overlap and workplan collisions.

Even though the id field is ignored when adding work, it must still be provided in the prodplanentry object.

Input

prodplanentryprodplanentryThe entry to add/update.

Output

prodplanentryprodplanentryThe created/modified prodplanentry

GetProductionByUserAndDate

Get all production in Microbizz regarding the specific user and date range. If no user is specified the active user is assumed.

Input

fromdatedateThe date to start from
todatedateThe date to end at
useridnumberId of the user for which to retrieve the plan
inclstatenumberSet to 1 to include info about the status of each planned task
inclactivitycolornumberSet to 1 to include the activity colour for each planning

Output

prodplanentriescollection[ prodplanentry ]A collection of all production or an empty collection if no production.
statecollection[array]The state information for each task, each array contains todoid and stateid; only included if inclstate was set
activitycolorscollection[string]The colors to use for each of the 6 activity states (0=closed,1=inprogress,2=visited,3=notvisited,4=later today,5=later); only included if inclactivitycolor was set

GetProductionByLastChange

Get all production in Microbizz that has changed since a given date/time.

Input

changedatedateReturn all production changed on or after the provided date.
changetimetimeIf this is provided only return production 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
skip_secondary_textbooleanIf this is set, then the field secondary_text will not be filled. But the performance of the call will be wastly improved.

Output

prodplanentriescollection[ prodplanentry ]A collection of all relevant production or an empty collection if no production.
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.

GetProdplanByTodoID

Get all production in Microbizz regarding the specific task.

Input

todoidnumberThe ID of the Todo
skippastbooleanIf 1 then only future planning will be read
typenumberEither 0 (only normal planning), or 1 (only full day planning) or -1 (both), default is 0

Output

prodplanentriescollection[ prodplanentry ]A collection of all production or an empty collection if no production.

ClearProductionByDate

Clear all work from the production plan in Microbizz, on a given date.

Input

datedateThe date on which to clear the work.

Output

none--

ClearProductionByID

Clear a production plan entry in Microbizz.

Input

idnumberThe Microbizz ID of the prodplanentry.

Output

none--