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
prodplanentry | The entry to add to the production plan. |
Output
prodplanentry | prodplanentry | The 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
prodplanentry | The entry to add/update. |
Output
prodplanentry | prodplanentry | The 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
fromdate | date | The date to start from |
todate | date | The date to end at |
userid | number | Id of the user for which to retrieve the plan |
inclstate | number | Set to 1 to include info about the status of each planned task |
inclactivitycolor | number | Set to 1 to include the activity colour for each planning |
Output
prodplanentries | collection[ prodplanentry ] | A collection of all production or an empty collection if no production. |
state | collection[array] | The state information for each task, each array contains todoid and stateid; only included if |
activitycolors | collection[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 |
GetProductionByLastChange
Get all production in Microbizz that has changed since a given date/time.
Input
changedate | date | Return all production changed on or after the provided date. |
changetime | time | If this is provided only return production 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 |
skip_secondary_text | boolean | If this is set, then the field secondary_text will not be filled. But the performance of the call will be wastly improved. |
Output
prodplanentries | collection[ prodplanentry ] | A collection of all relevant production or an empty collection if no production. |
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. |
GetProdplanByTodoID
Get all production in Microbizz regarding the specific task.
Input
todoid | number | The ID of the Todo |
skippast | boolean | If 1 then only future planning will be read |
type | number | Either 0 (only normal planning), or 1 (only full day planning) or -1 (both), default is 0 |
Output
prodplanentries | collection[ 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
date | date | The date on which to clear the work. |
Output
none | - | - |
ClearProductionByID
Clear a production plan entry in Microbizz.
Input
id | number | The Microbizz ID of the prodplanentry. |
Output
none | - | - |