Tasks
To see the parameters of a command, simply run dimescheduler task --help command and you'll get all the information you need.
Task
A task is a loose term to describe work that needs to be scheduled and executed. In Dime.Scheduler nomenclature, there are two types of tasks: open tasks and planned tasks.
Every task that you create through this endpoint is by default an open task, or a task that is yet to be planned. A planned task is nothing more than an open task that has been assigned a date and a resource. A planned task is also known as an appointment.
Open tasks appear in the open tasks lists while planned tasks are available in the planning board and the planned tasks list.
A task needs a link to a job. A job is the containing entity that holds the link to the back-office systems and are therefore essential. Jobs have information about high-level topics such as customers, while tasks hold the information about the work itself. Because of this data model, tasks can be very low-level and there can be many tasks for a given job.
dimescheduler task {action} -k "MYAPIKEY"
{--sourceapp}
{--sourcetype}
{--jobno}
{--taskno}
{--shortdescription}
[--description]
[--createjob]
[--tasktype]
[--name]
[--type]
[--category]
[--timemarker]
[--pin]
[--serviceno]
[--servicegroup]
[--serviceclass]
[--serviceserialno]
[--servicename]
[--irisfault]
[--irissymptom]
[--irisarea]
[--irisreason]
[--irisresolution]
[--skill1]
[--skill2]
[--skill3]
[--contractno]
[--contracttype]
[--contractdescription]
[--contractstartdate]
[--contractenddate]
[--partswarrantystartdate]
[--partswarrantyenddate]
[--laborwarrantystartdate]
[--laborwarrantyenddate]
[--importance]
[--status]
[--expectedresponsedatetime]
[--actualresponsedatetime]
[--requestedstartdate]
[--requestedenddate]
[--requestedstarttime]
[--requestedendtime]
[--confirmedstartdate]
[--confirmedenddate]
[--actualstartdate]
[--actualenddate]
[--locationdescription]
[--duration]
[--durationinseconds]
[--subject]
[--body]
[--infinitetask]
[--taskopenasof]
[--taskopentill]
[--requiredtotalduration]
[--requirednoresources]
[--appointmentearliestallowed]
[--appointmentlatestallowed]
[--freetext1]
[--freetext2]
[--freetext3]
[--freetext4]
[--freetext5]
[--freetext6]
[--freetext7]
[--freetext8]
[--freetext9]
[--freetext10]
[--freetext11]
[--freetext12]
[--freetext13]
[--freetext14]
[--freetext15]
[--freetext16]
[--freetext17]
[--freetext18]
[--freetext19]
[--freetext20]
[--freedecimal1]
[--freedecimal2]
[--freedecimal3]
[--freedecimal4]
[--freedecimal5]
[--freedate1]
[--freedate2]
[--freedate3]
[--freedate4]
[--freedate5]
[--freebit1]
[--freebit2]
[--freebit3]
[--freebit4]
[--freebit5]
[--url1]
[--urldescription1]
[--url2]
[--urldescription2]
[--url3]
[--urldescription3]
[--certificateno]
[--requiredtotaldurationinseconds]
[--donotcountappointmentresource]
[--iscomplete]
[--planninguom]
[--planninguomconversion]
[--planningqty]
[--usefixplanningqty]
[--roundtouom]
[--appointmenttemplate]
[--bulkplanningqty]
[--startdate]
[--enddate]
[--percentdone]
[--schedulingmode]
[--baselinestartdate]
[--baselineenddate]
[--baselinepercentdone]
[--deadline]
[--index]
[--constrainttype]
[--constraintdatetime]
[--parenttaskno]
[--calendarcode]
[--predecessortaskno]
[--predecessorlag]
[--manuallyscheduled]
[--note]
[--overruleganttplanning]
[--ignorecalendars]
[--containername]
[--containerindex]
[--checkappointments]
Parameters in [square brackets] represent optional parameters. Parameters in {curly brackets} are mandatory. For a complete overview, check out the API reference docs.
Attributes
Container
dimescheduler taskcontainer {action} -k "MYAPIKEY"
Filter value
dimescheduler taskfiltervalue {action} -k "MYAPIKEY"
Locked
dimescheduler tasklocked {action} -k "MYAPIKEY"
URI
dimescheduler taskuri {action} -k "MYAPIKEY"