Dime.Scheduler (Preview)

Reference

Dime.Scheduler is a resource and project planning solution that extends the capabilities of ERP, CRM and other business systems with powerful graphical scheduling tools.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Dime.Scheduler Support
URL	https://docs.dimescheduler.com
Email	support@dimescheduler.com

Connector Metadata
Publisher	Dime Software
Website	https://www.dimescheduler.com
Privacy Policy	https://www.dimescheduler.com/privacy
Categories	Business Management;Data

Dime.Scheduler is the resource and project planning solution for Microsoft Dynamics and Microsoft 365. By linking the Power Platform to Dime.Scheduler, power users may extend their own applications and build powerful, bespoke solutiosn.

Prerequisites

To successfully deploy the Power Platform connector, ensure you have met the following requirements:

A Microsoft Power Apps or Power Automate plan with custom connector feature.
A running Dime.Scheduler instance that is publicly accessible.
A Dime.Scheduler Connect API key.

How to get credentials

To use the Power Platform connector with minimal setup, you may use Dime.Scheduler Connect, a hosted cloud service which connects the Power Platform to your particular Dime.Scheduler instance. To use the service, you need to sign up and create an API key.

The process is fairly straightforward:

Go to https://connect.dimescheduler.com and create an account there.
You will receive an e-mail shortly to confirm your account.
Follow the instructions as specified there.

Go to the Tiers page and select the tier that meets your needs.
Subscribe to this tier by giving it a name and click the Subscribe button.
You will automatically be redirected to the profile page where you can check your subscriptions and the API keys
Finally, click the 'Show' button of the primary key and copy the value that's shown.

Paste this value in the API key field of the Power Platform connector and you're good to go.

Get started with your connector

The connector can be used in any PowerApp or Power Automate Flow. With the connector, you can manage:

Resources
Work orders
Requirements and attributes
Color coding
Locations on the map

For more information, consult our docs.

Known issues and limitations

N/A

Common errors and remedies

The most common HTTP status code, apart from 200 obviously, is the 500 code. This is usually a result of incorrect data. Consult the docs for a complete list of the actions and the required parameters. Apart from that, a 401 error might occur, which is a result of invalid credentials.

Consult the docs for more information on the Power Platform connector for Dime.Scheduler.

FAQ

N/A

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Environment	string	Environment	True
API Key	securestring	The API key to use the service	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add an appointment	Add an appointment.
Add or update a calendar for a resource	Add or update a calendar for a resource.
Add or update a caption	Add or update a caption.
Add or update a category	Add or update a category, which is the visual indicator that renders the background of the appointment.
Add or update a container	Add or update a container.
Add or update a filter group	Add or update a filter group.
Add or update a filter value	Add or update a filter value.
Add or update a job	Add or update a job.
Add or update a notification	Add or update a notification.
Add or update a pin	Add or update a pin, which is the visual indicator that renders the colors of the markers on the map.
Add or update a resource	Add or update a resource.
Add or update a task	Add or update a task.
Add or update a task container	Add or update a task container.
Add or update a task filter value	Add or update a task filter value.
Add or update a time marker	Add or update a time marker, which is the visual indicator that renders the underscore of the appointment.
Add or update an action link	Add or update an action link.
Add or update an appointment container	Add or update an appointment container.
Add or update an appointment link	Add or update an appointment link.
Add or update an assignment	Add or update an assignment, which is the allocation of a resource to an appointment.
Remove a calendar for a resource	Remove a calendar for a resource.
Remove a caption	Remove a caption.
Remove a category	Remove a category, which is the visual indicator that renders the background of the appointment.
Remove a container	Remove a container.
Remove a filter group	Remove a filter group.
Remove a filter value	Remove a filter value.
Remove a job	Remove a job.
Remove a notification	Remove a notification.
Remove a pin	Remove a pin, which is the visual indicator that renders the colors of the markers on the map.
Remove a resource	Remove a resource.
Remove a task	Remove a task.
Remove a task container	Remove a task container.
Remove a task filter value	Remove a task filter value.
Remove a time marker	Remove a time marker, which is the visual indicator that renders the underscore of the appointment.
Remove an action link	Remove an action link.
Remove an appointment	Remove an appointment.
Remove an appointment container	Remove an appointment container.
Remove an appointment link	Remove an appointment link.
Remove an assignment	Remove an assignment, which is the allocation of a resource to an appointment.
Remove the capacity of a resource	Remove the capacity of a resource.
Remove the filter value of a resource	Remove the filter value of a resource.
Remove the live location of a resource	Remove the live location of a resource.
Remove the uri of a resource	Remove the uri of a resource.
Set the appointment's locked status	Set the appointment's locked status.
Set the appointment's planning quantity	Set the appointment's planning quantity.
Set the capacity of a resource	Set the capacity of a resource.
Set the category of an appointment	Set the category of an appointment.
Set the content of the appointment	Set the content of the appointment.
Set the filter value of a resource	Set the filter value of a resource.
Set the live location of a resource	Set the live location of a resource.
Set the priority of an appointment	Set the priority of an appointment.
Set the task's locked status	Set the task's locked status.
Set the time marker of an appointment	Set the time marker of an appointment
Set the uri of a resource	Set the uri of a resource.
Update an appointment	Update an appointment.

Add an appointment

Operation ID:: appointmentUpsert

Add an appointment.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Subject	subject		string	The appointment's subject
Body	body		string	The appointment's body
Start	start	True	date-time	The start date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
End	end	True	date-time	The end date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
Time Marker	timeMarkerId		integer	Specifies the color of the horizontal bar at the bottom of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Category	categoryId		integer	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Importance	importance		integer
Locked	locked		boolean	Set to true to make the appointment immutable.
Replace resource	replaceResource		boolean
Back office id	backOfficeId		string
Back office parent id	backOfficeParentId		string
Unit of measure	unitOfMeasure		string
Unit of measure conversion	unitOfMeasureConversion		double
Planning quantity	planningQuantity		double
Use fixed planning quantity	useFixedPlanningQuantity		boolean
Round to unit of measure	roundToUnitOfMeasure		boolean
Sent from back office	sentFromBackOffice		boolean

Add or update a calendar for a resource

Operation ID:: resourceCalendarUpsert

Add or update a calendar for a resource.

Parameters

Name	Key	Required	Type	Description
Code	code	True	string	The resource calendar code
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Calendar code	calendarCode	True	string	The resource calendar
Start date	startDate	True	date-time	The start date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
End date	endDate	True	date-time	The end date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z

Add or update a caption

Operation ID:: captionUpsert

Add or update a caption.

Parameters

Name	Key	Required	Type	Description
Context	context	True	integer
Source table	sourceTable		string	The entity name. Choose between Job, Resource, Task, Appointment
Field name	fieldName		string	The field's identifier
Language	language		string	The language code
Text	text		string	The custom caption

Add or update a category

Operation ID:: categoryUpsert

Add or update a category, which is the visual indicator that renders the background of the appointment.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Display name	displayName	True	string	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Color	color		string	The hex color code

Add or update a container

Operation ID:: containerUpsert

Add or update a container.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The container's name
Handle date	handleDate		date-time	The handle date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
Handle locked	handleLocked		boolean	True to fix the relative position of the handle bar to the container members.

Operation ID:: filterGroupUpsert

Add or update a filter group.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The name that describes the group of filter values.
Column no.	columnNo		integer
Date filter	dataFilter		boolean

Add or update a filter value

Operation ID:: filterValueUpsert

Add or update a filter value.

Parameters

Name	Key	Required	Type	Description
Group	group	True	string	The name of the filter group. For example: Skill, Region, Language.
Value	value	True	string	The name that describes this filter value. For example: French, English, Spanish.

Add or update a job

Operation ID:: jobUpsert

Add or update a job.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Short description	shortDescription	True	string	Summary of the scope of this job
Description	description		string	Describes the scope of this job
Type	type		string	The type of job
Name	name		string	The job's name
Time Marker	timeMarker		string	Specifies the color of the horizontal bar at the bottom of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Category	category		string	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Pin	pin		string	Specifies the color of the marker on the map
Customer no.	customerNo		string	The customer number
Customer name	customerName		string	The customer name
Customer address	customerAddress		string	The customer address
Customer address longitude	customerAddressGeoLong		string	The customer's address longitude coordinate
Customer address latitude	customerAddressGeoLat		string	The customer's address latitude coordinate
Customer phone	customerPhone		string	The customer's phone number
Customer e-mail	customerEmail		email	The customer's email address
Contact no.	contactNo		string	The customer's contact number
Contact name	contactName		string	The customer's contact name
Contact address	contactAddress		string	The customer's contact address
Contact address longitude	contactAddressGeoLong		string
Contact address latitude	contactAddressGeoLat		string
Contact phone	contactPhone		string	The customer's contact phone
Contact e-mail	contactEmail		email	The customer's contact email address
Site no.	siteNo		string	The job's site number
Site name	siteName		string	The job's site name
Site address	siteAddress		string	The job's site address. This field is used in geocoding.
Site address longitude	siteAddressGeoLong		string
Site address latitude	siteAddressGeoLat		string
Site phone	sitePhone		string	The job's site phone number
Site e-mail	siteEmail		email	The job's site email address
Site region	siteRegion		string	The job's site region. This field is used in geocoding.
Site street	siteStreet		string	The job's site street. This field is used in geocoding.
Site street no.	siteStreetNo		string	The job's site street number. This field is used in geocoding.
Site post code	sitePostcode		string	The job's site ZIP number. This field is used in geocoding.
Site city	siteCity		string	The job's site city. This field is used in geocoding.
Site county	siteCounty		string	The job's site county. This field is used in geocoding.
Site state	siteState		string	The job's site state. This field is used in geocoding.
Site country	siteCountry		string	The job's site country. This field is used in geocoding.
Site from no.	siteFromNo		string	The job's site from number.
Site from name	siteFromName		string	The job's site from name.
Site from address	siteFromAddress		string	The job's site from address.
Site from longitude	siteFromAddressGeoLong		string
Site from latitude	siteFromAddressGeoLat		string
Site from phone	siteFromPhone		string	The job's site from phone number.
Site from e-mail	siteFromEmail		email	The job's site from email address.
Site from region	siteFromRegion		string	The job's site from region.
Site from street	siteFromStreet		string	The job's site from street.
Site from street no.	siteFromStreetNo		string	The job's site from street no.
Site from post code	siteFromPostcode		string	The job's site from ZIP code.
Site from city	siteFromCity		string	The job's site from city.
Site from county	siteFromCounty		string	The job's site from county.
Site from state	siteFromState		string	The job's site from state.
Site from country	siteFromCountry		string	The job's site from country.
Bill no.	billNo		string	The job's billing number.
Bill name	billName		string	The job's billing name.
Bill address	billAddress		string	The job's billing address.
Bill address longitude	billAddressGeoLong		string
Bill address latitude	billAddressGeoLat		string
Bill phone	billPhone		string	The job's billing phone number.
Bill e-mail	billEmail		email	The job's billing email address.
Bill region	billRegion		string	The job's billing region.
Importance	importance		integer	The job's priority.
Creation datetime	creationDateTime		date-time	Created on.
Customer reference	customerReference		string	The customer's reference
Language	language		string	The job's language.
Responsible	responsible		string	The job's responsible.
Creator	creator		string	The job's creator.
Free text field #1	freeText1		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #2	freeText2		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #3	freeText3		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #4	freeText4		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #5	freeText5		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #6	freeText6		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #7	freeText7		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #8	freeText8		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #9	freeText9		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #10	freeText10		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #11	freeText11		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #12	freeText12		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #13	freeText13		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #14	freeText14		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #15	freeText15		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #16	freeText16		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #17	freeText17		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #18	freeText18		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #19	freeText19		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #20	freeText20		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #1	freeDecimal1		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #2	freeDecimal2		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #3	freeDecimal3		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #4	freeDecimal4		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #5	freeDecimal5		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #1	freeDate1		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #2	freeDate2		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #3	freeDate3		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #4	freeDate4		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #5	freeDate5		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #1	freeBit1		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #2	freeBit2		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #3	freeBit3		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #4	freeBit4		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #5	freeBit5		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Enable manual selection	enableManualSelection		boolean
Available in Gantt chart	availableInGantt		boolean
Start date	startDate		date-time
End date	endDate		date-time
Allow dependencies	allowDependencies		boolean
Note	note		string
Overrule Gantt chart planning	overRuleGanttPlanning		boolean
Check appointments	checkAppointments		boolean	True to check before removing whether appointments have been planned for this record.
Sent from back-office	sentFromBackOffice		boolean

Add or update a notification

Operation ID:: notificationUpsert

Add or update a notification.

Parameters

Name	Key	Type	Description
Source application	sourceApp	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId	integer	The unique number to identify this appointment
Job no.	jobNo	string	Optional. Specify the job number to create a notification for all tasks and appointments that belong to this job.
Task no.	taskNo	string	Optional. Specify the task number to create a notification for all appointments that belong to this task.
Appointment No	appointmentNo	string	Optional. Specify the appointment number to create a notification for this particular appointment.
Type	type	integer	The severity of this notification.
Code	code	string	The notification code.
Text	text	string	The notification message.
Date	date	date-time	Optional. The date stamp for this notification.
Appointment GUID	appointmentGuid	uuid	The GUID to identify this appointment
Sent from back-office	sentFromBackOffice	boolean
Connector id	connectorId	string

Add or update a pin

Operation ID:: pinUpsert

Add or update a pin, which is the visual indicator that renders the colors of the markers on the map.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The name of the marker.
Color	color		string	The marker's hex color code

Add or update a resource

Operation ID:: resourceUpsert

Add or update a resource.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Resource type	resourceTypeId		integer	Categorizes the resources
Resource name	resourceName		string	The resource name
Display name	displayName		string	The resource's display name
Department	department		string	The resource's department
E-mail	email		email	The resource's email address. This field is used in the bi-directional Exchange connector.
Phone	phone		string	The resource's phone number
Mobile phone	mobilePhone		string	The resource's mobile phone number
Replacement resource	replacementResource		boolean	A boolean to represent if this resource is to be replaced.
Field service e-mail	fieldServiceEmail		email	The resource's field service email
Person e-mail	personalEmail		email	The resource's personal email
GPS tracking no.	gpsTrackingResourceNo		string	The resource's GPS tracking number
Home address	homeAddress		string	The resource's home address. This field is used in geocoding.
Home address longitude	homeAddressGeoLong		float
Home address latitude	homeAddressGeoLat		float
Home phone	homePhone		string	The resource's home phone.
Home e-mail	homeEmail		email	The resource's home email.
Home street	homeStreet		string	The resource's home street.
Home street no.	homeStreetNo		string	The resource's home street number. This field is used in geocoding.
Home post code	homePostcode		string	The resource's home ZIP code. This field is used in geocoding.
Home city	homeCity		string	The resource's home city. This field is used in geocoding.
Home county	homeCounty		string	The resource's home county. This field is used in geocoding.
Home state	homeState		string	The resource's home state. This field is used in geocoding.
Home country	homeCountry		string	The resource's home country. This field is used in geocoding.
Home region	homeRegion		string	The resource's home region. This field is used in geocoding.
Team code	teamCode		string	The resource's team code
Team name	teamName		string	The resource's team name
Team type	teamType		string	The resource's team type
Team sort	teamSort		integer	The resource's team sorting
Team member type	teamMemberType		string	The resource's team member type
Team member sort	teamMemberSort		integer	The resource's team member sorting
Do not show	doNotShow		boolean	Set to true to hide the resource from the planning board. Set to false to exclude this resource from the license count.
Enable Exchange integration	exchangeIntegrationEnabled		boolean	Set to true to synchronize the planning to the resource's Exchange calendar. This field is used in the Exchange connector.
Enable resource GPS tracking	resourceGpsTrackingEnabled		boolean	Set to true to enable track and trace for this resource on the map.
In service from	inServiceFrom		date-time	In service from date
In service until	inServiceTill		date-time	In service until date
URL 1	url1		string	A custom URI for this resource.
URL description #1	urlDescription1		string	A custom URI for this resource.
URL 2	url2		string	A custom URI for this resource.
URL description #2	urlDescription2		string	A custom URI for this resource.
URL 3	url3		string	A custom URI for this resource.
URL description #3	urlDescription3		string	A custom URI for this resource.
Bulk planning	bulkPlanning		boolean	True to enable bulk planning.
Bulk capacity	bulkCapacity		double	Bulk planning capacity
The pin indicator	pin		string	Specifies the color of the marker on the map
Free text field #1	freeText1		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #2	freeText2		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #3	freeText3		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #4	freeText4		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #5	freeText5		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #6	freeText6		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #7	freeText7		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #8	freeText8		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #9	freeText9		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #10	freeText10		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #11	freeText11		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #12	freeText12		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #13	freeText13		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #14	freeText14		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #15	freeText15		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #16	freeText16		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #17	freeText17		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #18	freeText18		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #19	freeText19		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #20	freeText20		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #1	freeDecimal1		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #2	freeDecimal2		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #3	freeDecimal3		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #4	freeDecimal4		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #5	freeDecimal5		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #1	freeDate1		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #2	freeDate2		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #3	freeDate3		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #4	freeDate4		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #5	freeDate5		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #1	freeBit1		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #2	freeBit2		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #3	freeBit3		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #4	freeBit4		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #5	freeBit5		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.

Add or update a task

Operation ID:: taskUpsert

Add or update a task.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Create job	createJob		boolean	Use this field to create a job for this task.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Task type	taskType		integer	Specify the component where planning will take place: Gantt chart or planning board.
Short description	shortDescription	True	string	Summary of the scope of this task
Description	description	True	string	Describes the scope of this task
Name	name		string	The task name
Type	type		string	The task type
Importance	importance		integer	The task's priority
Time Marker	timeMarker		string	Specifies the color of the horizontal bar at the bottom of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Category	category		string	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Pin	pin		string	Specifies the color of the marker on the map
Required total duration (in seconds)	requiredTotalDurationInSeconds		integer	Specifies the required total duration (= the budget) in seconds
Expected response date	expectedResponseDateTime		date-time	The expected response date
Actual response date	actualResponseDateTime		date-time	The actual response date
Requested start date	requestedStartDate		date-time	Overrides the appointment's start date when dropping a task to the planning board.
Requested end date	requestedEndDate		date-time	Overrides the appointment's end date when dropping a task to the planning board.
Requested start time	requestedStartTime		string	Overrides the appointment's start time when dropping a task to the planning board.
Requested end time	requestedEndTime		string	Overrides the appointment's end time when dropping a task to the planning board.
Earliest allowed time	appointmentEarliestAllowed		date-time	Specifies the earliest date allowed for the task
Latest allowed time	appointmentLatestAllowed		date-time	Specifies the latest date allowed for the task
Confirmed start date	confirmedStartDate		date-time	Confirmed start date
Confirmed end date	confirmedEndDate		date-time	Confirmed end date
Actual start date	actualStartDate		date-time	Actual start date
Actual end date	actualEndDate		date-time	Actual end date
Service no.	serviceNo		string	Service no.
Service group	serviceGroup		string	Service group
Service class	serviceClass		string	Service class
Service serial no.	serviceSerialNo		string	Service serial no.
Service name	serviceName		string	Service name
IRIS fault	irisFault		string	IRIS fault
IRIS symptom	irisSymptom		string	IRIS symptom
IRIS area	irisArea		string	IRIS area
IRIS reason	irisReason		string	IRIS reason
IRIS resolution	irisResolution		string	IRIS resolution
Skill #1	skill1		string	Skill #1
Skill #2	skill2		string	Skill #2
Skill #3	skill3		string	Skill #3
Contract number	contractNo		string	Contract number
Contract type	contractType		string	Contract type
Contract description	contractDescription		string	Contract description
Contract start date	contractStartDate		date-time	Contract start date
Contract end date	contractEndDate		date-time	Contract end date
Parts warranty start date	partsWarrantyStartDate		date-time	Parts warranty start date
Parts warranty end date	partsWarrantyEndDate		date-time	Parts warranty end date
Labor warranty start date	laborWarrantyStartDate		date-time	Labor warranty start date
Labor warranty end date	laborWarrantyEndDate		date-time	Labor warranty end date
Status	status		string	Status
Location description	locationDescription		string	Location description
Duration	duration		string	Duration
Duration in seconds	durationInSeconds		integer	Duration in seconds
Subject	subject		string	The appointment's subject
Body	body		string	The appointment's body
Is infinite task	infiniteTask		boolean	Setting this to true will pin this task on the open tasks grid.
Open from date	taskOpenAsOf		date-time	Open from date
Open until date	taskOpenTill		date-time	Open until date
Required total duration	requiredTotalDuration		string	Required total duration
Required number of resources	requiredNoResources		integer	Required number of resources
Free text field #1	freeText1		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #2	freeText2		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #3	freeText3		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #4	freeText4		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #5	freeText5		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #6	freeText6		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #7	freeText7		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #8	freeText8		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #9	freeText9		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #10	freeText10		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #11	freeText11		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #12	freeText12		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #13	freeText13		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #14	freeText14		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #15	freeText15		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #16	freeText16		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #17	freeText17		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #18	freeText18		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #19	freeText19		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #20	freeText20		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #1	freeDecimal1		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #2	freeDecimal2		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #3	freeDecimal3		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #4	freeDecimal4		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #5	freeDecimal5		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #1	freeDate1		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #2	freeDate2		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #3	freeDate3		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #4	freeDate4		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free date field #5	freeDate5		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #1	freeBit1		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #2	freeBit2		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #3	freeBit3		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #4	freeBit4		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #5	freeBit5		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
URL 1	url1		string	Custom URI for this task
URL 1 description	urlDescription1		string	Custom URI for this task
URL 2	url2		string	Custom URI for this task
URL 2 description	urlDescription2		string	Custom URI for this task
URL 3	url3		string	Custom URI for this task
URL 3 description	urlDescription3		string	Custom URI for this task
Certificate no.	certificateNo		string	Custom URI for this task
Do not count appointment resources	doNotCountAppointmentResource		boolean	Do not count appointment resources
Is complete	isComplete		boolean	Is complete
Planning unit of measure	planningUOM		string	Planning unit of measure
Planning quantity	planningQty		double	Planning quantity
Use fixed planning quantity	useFixPlanningQty		boolean	Use fixed planning quantity
Round to unit of measure	roundToUOM		boolean	Round to unit of measure
Appointment template	appointmentTemplate		string	Appointment template
Bulk planning quantity	bulkPlanningQty		double	Bulk planning quantity
Calendar	calendarCode		string	Calendar
Gantt: Start date	startDate		date-time	Gantt: Start date
Gantt: End date	endDate		date-time	Gantt: End date
Gantt: Percentage done	percentDone		integer	Gantt: Percentage done
Gantt: Scheduling mode	schedulingMode		integer	Gantt: Scheduling mode
Gantt: Baseline start date	baseLineStartDate		date-time	Gantt: Baseline start date
Gantt: Baseline end date	baseLineEndDate		date-time	Gantt: Baseline end date
Gantt: Baseline percent done	baseLinePercentDone		integer	Gantt: Baseline percent done
Gantt: Deadline	deadLine		date-time	Gantt: Deadline
Gantt: Index	index		integer	Gantt: Index
Gantt: Constraint type	constraintType		integer	Gantt: Constraint type
Gantt: Constraint datetime	constraintDatetime		date-time	Gantt: Constraint datetime
Gantt: Parent task no.	parentTaskNo		string	Gantt: Parent task no.
Gantt: Predecessor task no.	predecessorTaskNo		string	Gantt: Predecessor task no.
Gantt: Predecessor lag	predecessorLag		integer	Gantt: Predecessor lag
Gantt: Manually scheduled	manuallyScheduled		boolean	Gantt: Manually scheduled
Gantt: Note	note		string	Gantt: Note
Gantt: Overrule Gantt planning	overRuleGanttPlanning		boolean	Gantt: Overrule Gantt planning
Ignore calendars	ignoreCalendars		boolean	Ignore calendars
Container name	containerName		string	Container name
Container index	containerIndex		integer	Container index
Check appointments	checkAppointments		boolean	True to check before removing whether appointments have been planned for this record.
Sent from back-office	sentFromBackOffice		boolean	Sent from back-office

Add or update a task container

Operation ID:: taskContainerUpsert

Add or update a task container.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Name	name	True	string	The container name
Index	index		integer	The index of the task in the container.

Add or update a task filter value

Operation ID:: taskFiltervalueUpsert

Add or update a task filter value.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Filter group	filterGroup	True	string	The filter group
Filter value	filterValue	True	string	The filter value
Transfer to temp	transferToTemp		boolean

Add or update a time marker

Operation ID:: Timemarker

Add or update a time marker, which is the visual indicator that renders the underscore of the appointment.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The name of this visual indicator.
Color	color		string	The hex color code

Add or update an action link

Operation ID:: actionUriUpsert

Add or update an action link.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
URI type	uriType		integer	The scope of the action URI
URI	uri	True	string	The URI to call upon invocation
Description	description		string	The display text of the action URI
Default	default		boolean

Add or update an appointment container

Operation ID:: appointmentContainerUpsert

Add or update an appointment container.

Parameters

Name	Key	Required	Type	Description
Container	container	True	string	The container code to assign this appointment to
Appointment	appointment	True	string	The appointment's identifier

Add or update an appointment link

Operation ID:: appointmentUriUpsert

Add or update an appointment link.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
URI	uri	True	string	The absolute URI
Description	description	True	string	The display text for the URI

Add or update an assignment

Operation ID:: assignmentUpsert

Add or update an assignment, which is the allocation of a resource to an appointment.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Sent from back-office	sentFromBackOffice		boolean

Remove a calendar for a resource

Operation ID:: resourceCalendarDelete

Remove a calendar for a resource.

Parameters

Name	Key	Required	Type	Description
Code	code	True	string	The resource calendar code
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Calendar code	calendarCode	True	string	The resource calendar
Start date	startDate	True	date-time	The start date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
End date	endDate	True	date-time	The end date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z

Remove a caption

Operation ID:: captionDelete

Remove a caption.

Parameters

Name	Key	Required	Type	Description
Context	context	True	integer
Source table	sourceTable		string	The entity name. Choose between Job, Resource, Task, Appointment
Field name	fieldName		string	The field's identifier
Language	language		string	The language code
Text	text		string	The custom caption

Remove a category

Operation ID:: categoryDelete

Remove a category, which is the visual indicator that renders the background of the appointment.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Display name	displayName	True	string	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Color	color		string	The hex color code

Remove a container

Operation ID:: containerDelete

Remove a container.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The container's name
Handle date	handleDate		date-time	The handle date. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
Handle locked	handleLocked		boolean	True to fix the relative position of the handle bar to the container members.

Operation ID:: filterGroupDelete

Remove a filter group.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The name that describes the group of filter values.
Column no.	columnNo		integer
Date filter	dataFilter		boolean

Remove a filter value

Operation ID:: filterValueDelete

Remove a filter value.

Parameters

Name	Key	Required	Type	Description
Group	group	True	string	The name of the filter group. For example: Skill, Region, Language.
Value	value	True	string	The name that describes this filter value. For example: French, English, Spanish.

Remove a job

Operation ID:: jobDelete

Remove a job.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Check appointments	checkAppointments		boolean	True to check before removing whether appointments have been planned for this record.

Remove a notification

Operation ID:: notificationDelete

Remove a notification.

Parameters

Name	Key	Type	Description
Source application	sourceApp	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId	integer	The unique number to identify this appointment
Job no.	jobNo	string	Optional. Specify the job number to create a notification for all tasks and appointments that belong to this job.
Task no.	taskNo	string	Optional. Specify the task number to create a notification for all appointments that belong to this task.
Appointment No	appointmentNo	string	Optional. Specify the appointment number to create a notification for this particular appointment.
Type	type	integer	The severity of this notification.
Code	code	string	The notification code.
Text	text	string	The notification message.
Date	date	date-time	Optional. The date stamp for this notification.
Appointment GUID	appointmentGuid	uuid	The GUID to identify this appointment
Sent from back-office	sentFromBackOffice	boolean
Connector id	connectorId	string

Remove a pin

Operation ID:: pinDelete

Remove a pin, which is the visual indicator that renders the colors of the markers on the map.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The name of the marker.
Color	color		string	The marker's hex color code

Remove a resource

Operation ID:: resourceDelete

Remove a resource.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Resource type	resourceTypeId		integer	Categorizes the resources
Resource name	resourceName		string	The resource name
Display name	displayName		string	The resource's display name
Department	department		string	The resource's department
E-mail	email		email	The resource's email address. This field is used in the bi-directional Exchange connector.
Phone	phone		string	The resource's phone number
Mobile phone	mobilePhone		string	The resource's mobile phone number
Replacement resource	replacementResource		boolean	A boolean to represent if this resource is to be replaced.
Field service e-mail	fieldServiceEmail		email	The resource's field service email
Person e-mail	personalEmail		email	The resource's personal email
GPS tracking no.	gpsTrackingResourceNo		string	The resource's GPS tracking number
Home address	homeAddress		string	The resource's home address. This field is used in geocoding.
Home address longitude	homeAddressGeoLong		float
Home address latitude	homeAddressGeoLat		float
Home phone	homePhone		string	The resource's home phone.
Home e-mail	homeEmail		email	The resource's home email.
Home street	homeStreet		string	The resource's home street.
Home street no.	homeStreetNo		string	The resource's home street number. This field is used in geocoding.
Home post code	homePostcode		string	The resource's home ZIP code. This field is used in geocoding.
Home city	homeCity		string	The resource's home city. This field is used in geocoding.
Home county	homeCounty		string	The resource's home county. This field is used in geocoding.
Home state	homeState		string	The resource's home state. This field is used in geocoding.
Home country	homeCountry		string	The resource's home country. This field is used in geocoding.
Home region	homeRegion		string	The resource's home region. This field is used in geocoding.
Team code	teamCode		string	The resource's team code
Team name	teamName		string	The resource's team name
Team type	teamType		string	The resource's team type
Team sort	teamSort		integer	The resource's team sorting
Team member type	teamMemberType		string	The resource's team member type
Team member sort	teamMemberSort		integer	The resource's team member sorting
Do not show	doNotShow		boolean	Set to true to hide the resource from the planning board. Set to false to exclude this resource from the license count.
Enable Exchange integration	exchangeIntegrationEnabled		boolean	Set to true to synchronize the planning to the resource's Exchange calendar. This field is used in the Exchange connector.
Enable resource GPS tracking	resourceGpsTrackingEnabled		boolean	Set to true to enable track and trace for this resource on the map.
In service from	inServiceFrom		date-time	In service from date
In service until	inServiceTill		date-time	In service until date
URL 1	url1		string	A custom URI for this resource.
URL description #1	urlDescription1		string	A custom URI for this resource.
URL 2	url2		string	A custom URI for this resource.
URL description #2	urlDescription2		string	A custom URI for this resource.
URL 3	url3		string	A custom URI for this resource.
URL description #3	urlDescription3		string	A custom URI for this resource.
Bulk planning	bulkPlanning		boolean	True to enable bulk planning.
Bulk capacity	bulkCapacity		double	Bulk planning capacity
The pin indicator	pin		string	Specifies the color of the marker on the map
Free text field #1	freeText1		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #2	freeText2		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #3	freeText3		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #4	freeText4		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #5	freeText5		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #6	freeText6		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #7	freeText7		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #8	freeText8		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #9	freeText9		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #10	freeText10		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #11	freeText11		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #12	freeText12		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #13	freeText13		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #14	freeText14		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #15	freeText15		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #16	freeText16		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #17	freeText17		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #18	freeText18		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #19	freeText19		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free text field #20	freeText20		string	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #1	freeDecimal1		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #2	freeDecimal2		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #3	freeDecimal3		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #4	freeDecimal4		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #5	freeDecimal5		double	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #1	freeDate1		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #2	freeDate2		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #3	freeDate3		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #4	freeDate4		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free decimal field #5	freeDate5		date-time	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #1	freeBit1		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #2	freeBit2		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #3	freeBit3		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #4	freeBit4		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.
Free boolean field #5	freeBit5		boolean	A field that is unmapped by default that can be used at your discretion. Use captions to change the title of this field.

Remove a task

Operation ID:: taskDelete

Remove a task.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Check appointments	checkAppointments		boolean	True to check before removing whether appointments have been planned for this record.

Remove a task container

Operation ID:: taskContainerDelete

Remove a task container.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Name	name	True	string	The container name
Index	index		integer	The index of the task in the container.

Remove a task filter value

Operation ID:: taskFiltervalueDelete

Remove a task filter value.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Filter group	filterGroup	True	string	The filter group
Filter value	filterValue	True	string	The filter value
Transfer to temp	transferToTemp		boolean

Remove a time marker

Operation ID:: timeMarkerDelete

Remove a time marker, which is the visual indicator that renders the underscore of the appointment.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The name of this visual indicator.
Color	color		string	The hex color code

Remove an action link

Operation ID:: actionUriDelete

Remove an action link.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
URI type	uriType		integer	The scope of the action URI
URI	uri	True	string	The URI to call upon invocation
Description	description		string	The display text of the action URI
Default	default		boolean

Remove an appointment

Operation ID:: appointmentDelete

Remove an appointment.

Parameters

Name	Key	Type	Description
Appointment id	appointmentId	integer	The unique number to identify this appointment
Appointment GUID	appointmentGuid	uuid	The GUID to identify this appointment
Appointment No	appointmentNo	string	The appointment's identifier
Source application	sourceApp	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	string	The unique identifier that is associated with the job.
Task no.	taskNo	string	The unique identifier that is associated with the task.
Resource no.	resourceNo	string	The unique identifier that is associated with the resource.
Subject	subject	string	The appointment's subject
Body	body	string	The appointment's body
Start	start	date-time	The start date of the appointment
End	end	date-time	The end date of the appointment
Time Marker	timeMarkerId	integer	Specifies the color of the horizontal bar at the bottom of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Category	categoryId	integer	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Importance	importance	integer
Locked	locked	boolean
Replace resource	replaceResource	boolean
Back office id	backOfficeId	string
Back office parent id	backOfficeParentId	string
Unit of measure	unitOfMeasure	string
Unit of measure conversion	unitOfMeasureConversion	double
Planning quantity	planningQuantity	double
Use fixed planning quantity	useFixedPlanningQuantity	boolean
Round to unit of measure	roundToUnitOfMeasure	boolean
Sent from back office	sentFromBackOffice	boolean

Remove an appointment container

Operation ID:: appointmentContainerDelete

Remove an appointment container.

Parameters

Name	Key	Required	Type	Description
Container	container	True	string	The container code to assign this appointment to
Appointment	appointment	True	string	The appointment's identifier

Remove an appointment link

Operation ID:: appointmentUriDelete

Remove an appointment link.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
URI	uri	True	string	The absolute URI
Description	description	True	string	The display text for the URI

Remove an assignment

Operation ID:: assignmentDelete

Remove an assignment, which is the allocation of a resource to an appointment.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Sent from back-office	sentFromBackOffice		boolean

Remove the capacity of a resource

Operation ID:: resourceCapacityDelete

Remove the capacity of a resource.

Parameters

Name	Key	Required	Type	Description
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Date	date		date-time	The date to set the resource's capacity. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
Capacity in seconds	capacityInSeconds		integer	The capacity in seconds
Quantity	quantity		double	The quantity.
Unit of measure	unitOfMeasure		string	Unit of measure
Unit of measure conversion	unitOfMeasureConversion		double	Unit of measure conversion

Remove the filter value of a resource

Operation ID:: resourceFilterValueDelete

Remove the filter value of a resource.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Filter group	filterGroup	True	string	The filter group
Filter value	filterValue	True	string	The filter value
Transfer to temp	transferToTemp		boolean

Remove the live location of a resource

Operation ID:: resourceGpstrackingDelete

Remove the live location of a resource.

Parameters

Name	Key	Required	Type	Description
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
GPS tracking resource no.	gpsTrackingResourceNo		string
Latitude	latitude	True	double	The latitude of this resource.
Longitude	longitude	True	double	The longitude of this resource.
Speed	speed		integer
Date	date		date-time
Row id	rowId		string
Power	power		string

Remove the uri of a resource

Operation ID:: resourceUriDelete

Remove the uri of a resource.

Parameters

Name	Key	Required	Type	Description
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
URI	uri		string
Description	description		string

Set the appointment's locked status

Operation ID:: appointmentLockedUpsert

Set the appointment's locked status.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Locked	locked	True	boolean	True to lock the appointment, and false to unlock.
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Sent from back-office	sentFromBackOffice		boolean

Set the appointment's planning quantity

Operation ID:: appointmentPlanningQuantityUpsert

Set the appointment's planning quantity.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Quantity	quantity	True	double	The planning quantity value
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Sent from back-office	sentFromBackOffice		boolean

Set the capacity of a resource

Operation ID:: resourceCapacityUpsert

Set the capacity of a resource.

Parameters

Name	Key	Required	Type	Description
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Date	date		date-time	The date to set the resource's capacity. Use ISO 8601 standard. For example 2023-11-16T10:09:21Z
Capacity in seconds	capacityInSeconds		integer	The capacity in seconds
Quantity	quantity		double	The quantity.
Unit of measure	unitOfMeasure		string	Unit of measure
Unit of measure conversion	unitOfMeasureConversion		double	Unit of measure conversion

Set the category of an appointment

Operation ID:: appointmentCategoryUpsert

Set the category of an appointment.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Category	category	True	string	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Sent from back-office	sentFromBackOffice		boolean

Set the content of the appointment

Operation ID:: appointmentContentUpsert

Set the content of the appointment.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Subject	subject		string	The appointment's subject
Body	body		string	The appointment's body
Sent from back-office	sentFromBackOffice		boolean

Set the filter value of a resource

Operation ID:: resourceFilterValueUpsert

Set the filter value of a resource.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
Filter group	filterGroup	True	string	The filter group
Filter value	filterValue	True	string	The filter value
Transfer to temp	transferToTemp		boolean

Set the live location of a resource

Operation ID:: resourceGpstrackingUpsert

Set the live location of a resource.

Parameters

Name	Key	Required	Type	Description
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
GPS tracking resource no.	gpsTrackingResourceNo		string
Latitude	latitude	True	double	The latitude of this resource.
Longitude	longitude	True	double	The longitude of this resource.
Speed	speed		integer
Date	date		date-time
Row id	rowId		string
Power	power		string

Set the priority of an appointment

Operation ID:: appointmentImportanceUpsert

Set the priority of an appointment.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Importance	importance	True	integer	The appointment's priority
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Sent from back-office	sentFromBackOffice		boolean

Set the task's locked status

Operation ID:: taskLockedUpsert

Set the task's locked status.

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	True	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	True	string	The unique identifier that is associated with the job.
Task no.	taskNo	True	string	The unique identifier that is associated with the task.
Locked	locked		boolean
Sent from back-office	sentFromBackOffice		boolean

Set the time marker of an appointment

Operation ID:: appointmentTimemarkerUpsert

Set the time marker of an appointment

Parameters

Name	Key	Required	Type	Description
Source application	sourceApp		string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType		string	A discriminator that describes the type of entity that this record represents.
Appointment id	appointmentId		integer	The unique number to identify this appointment
Appointment No	appointmentNo	True	string	The appointment's identifier
Time marker	timeMarker	True	string	Specifies the color of the horizontal bar at the bottom of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Appointment GUID	appointmentGuid		uuid	The GUID to identify this appointment
Sent from back-office	sentFromBackOffice		boolean

Set the uri of a resource

Operation ID:: resourceUriUpsert

Set the uri of a resource.

Parameters

Name	Key	Required	Type	Description
Resource no.	resourceNo	True	string	The unique identifier that is associated with the resource.
URI	uri		string
Description	description		string

Update an appointment

Operation ID:: appointmentUpdate

Update an appointment.

Parameters

Name	Key	Type	Description
Appointment id	appointmentId	integer	The unique number to identify this appointment
Appointment GUID	appointmentGuid	uuid	The GUID to identify this appointment
Appointment No	appointmentNo	string	The appointment's identifier
Source application	sourceApp	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Source type	sourceType	string	A discriminator that describes the type of entity that this record represents.
Job no.	jobNo	string	The unique identifier that is associated with the job.
Task no.	taskNo	string	The unique identifier that is associated with the task.
Resource no.	resourceNo	string	The unique identifier that is associated with the resource.
Subject	subject	string	The appointment's subject
Body	body	string	The appointment's body
Start	start	date-time	The start date of the appointment
End	end	date-time	The end date of the appointment
Time Marker	timeMarkerId	integer	Specifies the color of the horizontal bar at the bottom of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Category	categoryId	integer	Specifies the background color of the appointment in the planning board. Used to represent any kind of status or property that applies to your business.
Importance	importance	integer
Locked	locked	boolean
Replace resource	replaceResource	boolean
Back office id	backOfficeId	string
Back office parent id	backOfficeParentId	string
Unit of measure	unitOfMeasure	string
Unit of measure conversion	unitOfMeasureConversion	double
Planning quantity	planningQuantity	double
Use fixed planning quantity	useFixedPlanningQuantity	boolean
Round to unit of measure	roundToUnitOfMeasure	boolean
Sent from back office	sentFromBackOffice	boolean

Triggers

When an appointment is created	This trigger is used for listening to new appointments scheduled in Dime.Scheduler.
When an appointment is deleted	This trigger is used for listening to appointments that have been removed in Dime.Scheduler.
When an appointment is updated	This trigger is used for listening to new appointments scheduled in Dime.Scheduler.

When an appointment is created

Operation ID:: CreateAppointment

This trigger is used for listening to new appointments scheduled in Dime.Scheduler.

Parameters

Name	Key	Required	Type	Description
Source App	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Name	name		string	Provide a descriptive name to identify the purpose of this flow in Dime.Scheduler.
changeType	changeType	True	array of string	Changes to listen on

Returns

Body: appointment-incoming

When an appointment is deleted

Operation ID:: DeleteAppointment

This trigger is used for listening to appointments that have been removed in Dime.Scheduler.

Parameters

Name	Key	Required	Type	Description
Source App	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
changeType	changeType	True	array of string	Changes to listen on

Returns

Body: appointment-incoming

When an appointment is updated

Operation ID:: UpdateAppointment

This trigger is used for listening to new appointments scheduled in Dime.Scheduler.

Parameters

Name	Key	Required	Type	Description
Source App	sourceApp	True	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
changeType	changeType	True	array of string	Changes to listen on

Returns

Body: appointment-incoming

Definitions

appointment-incoming

Name	Path	Type	Description
Appointment No	appointmentNo	string	The appointment's identifier
id	id	integer
ExternalId	ExternalId	integer
Subject	Subject	string	The appointment's subject
Body	Body	string	The appointment's body
Start date	StartDate	date-time	The appointment's start date
End date	EndDate	date-time	The appointment's end date
Importance	Importance	integer	The priority of this appointment
AppointmentGuid	AppointmentGuid	string	The appointment's GUID
Locked	Locked	boolean	Set to true if the appointment is immutable.
Planning unit of measure	PlanningUOM	string	Planning unit of measure
Planning quantity	PlanningQty	double	Planning quantity
Use fixed planning quantity	UseFixPlanningQty	boolean	Set to true to use fixed planning quantity
Round to unit of measure	RoundToUOM	boolean	Set to true when round to unit of measure
Last modified date	LastModifiedDate	string
Last modified user	LastModifiedUser	string
Is recurrence exception	IsRecurrenceException	boolean
Capacity indicator	CapacityIndicator	boolean
AppointmentFieldValues	AppointmentFieldValues	array of
AppointmentUrls	AppointmentUrls	array of
AppointmentContainers	AppointmentContainers	array of
Notifications	Notifications	array of
Created on	CreatedDate	string
Created by	CreatedUser	string
Task No	Task.TaskNo	string
Job source app	Task.Job.SourceApp	string
Job source type	Task.Job.SourceType	string
Job No	Task.Job.JobNo	string
Category name	Category.DisplayName	string
Category color	Category.Color	string
Time marker name	TimeMarker.Name	string
Time marker color	TimeMarker.Color	string
Assignments	Assignments	array of object	The list of resources assigned to the appointment.
Resource type name	Assignments.Resource.ResourceType.DisplayName	string
Resource source app	Assignments.Resource.SourceApp	string	A unique identifier that lets Dime.Scheduler know to which back-office system this record belongs to.
Resource source type	Assignments.Resource.SourceType	string	A discriminator that describes the type of entity that this record represents.
Resource display name	Assignments.Resource.DisplayName	string
Resource department	Assignments.Resource.Department	string
Resource Number	Assignments.Resource.ResourceNo	string
Resource email	Assignments.Resource.Email	string

Delen via

Dime.Scheduler (Preview)

Prerequisites

How to get credentials

Sign up

Sign in

Get started with your connector

Known issues and limitations

Common errors and remedies

FAQ

Creating a connection

Default

Throttling Limits

Actions

Add an appointment

Parameters

Add or update a calendar for a resource

Parameters

Add or update a caption

Parameters

Add or update a category

Parameters

Add or update a container

Parameters

Add or update a filter group

Parameters

Add or update a filter value

Parameters

Add or update a job

Parameters

Add or update a notification

Parameters

Add or update a pin

Parameters

Add or update a resource

Parameters

Add or update a task

Parameters

Add or update a task container

Parameters

Add or update a task filter value

Parameters

Add or update a time marker

Parameters

Add or update an action link

Parameters

Add or update an appointment container

Parameters

Add or update an appointment link

Parameters

Add or update an assignment

Parameters

Remove a calendar for a resource

Parameters

Remove a caption

Parameters

Remove a category

Parameters

Remove a container

Parameters

Remove a filter group

Parameters

Remove a filter value

Parameters

Remove a job

Parameters

Remove a notification

Parameters

Remove a pin

Parameters

Remove a resource

Parameters

Remove a task

Parameters

Remove a task container

Parameters

Remove a task filter value

Parameters

Remove a time marker

Parameters