Dime.Scheduler (on-prem) (Preview)
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 protected] |
| 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 solutions.
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.
Sign up
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.
Sign in
- 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.
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.
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 |
|---|---|---|---|
| Dime.Scheduler URI | string | The base URI (with scheme) of Dime.Scheduler | True |
| E-mail address | string | The Dime.Scheduler user's e-mail address | True |
| Password | securestring | The Dime.Scheduler user's password | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add, update or remove a calendar for a resource |
Add, update or remove a calendar for a resource. |
| Add, update or remove a caption |
Add, update or remove a caption. |
| Add, update or remove a category |
Add, update or remove a category, which is the visual indicator that renders the background of the appointment. |
| Add, update or remove a container |
Add, update or remove a container. |
| Add, update or remove a filter group |
Add, update or remove a filter group. |
| Add, update or remove a filter value |
Add, update or remove a filter value. |
| Add, update or remove a job |
Add, update or remove a job. |
| Add, update or remove a pin |
Add, update or remove a pin, which is the visual indicator that renders the colors of the markers on the map. |
| Add, update or remove a resource |
Add, update or remove a resource. |
| Add, update or remove a task |
Add, update or remove a task. |
| Add, update or remove a task container |
Add, update or remove a task container. |
| Add, update or remove a task filter value |
Add, update or remove a task filter value. |
| Add, update or remove a time marker |
Add, update or remove a time marker, which is the visual indicator that renders the underscore of the appointment. |
| Add, update or remove an action link |
Add, update or remove an action link. |
| Add, update or remove an appointment |
Add, update or remove an appointment. |
| Add, update or remove an appointment container |
Add, update or remove an appointment container. |
| Add, update or remove an appointment link |
Add, update or remove an appointment link. |
| Add, update or remove an assignment |
Add, update or remove an assignment, which is the allocation of a resource to an appointment. |
| Add, update or remove notification |
Add, update or remove notification. |
| Add, update or remove the appointment's locked status |
Add, update or remove the appointment's locked status. |
| Add, update or remove the appointment's planning quantity |
Add, update or remove the appointment's planning quantity. |
| Add, update or remove the appointment's time marker |
Add, update or remove the appointment's time marker. |
| Add, update or remove the capacity of a resource |
Add, update or remove the capacity of a resource. |
| Add, update or remove the category of an appointment |
Add, update or remove the category of an appointment. |
| Add, update or remove the content of the appointment |
Add, update or remove the content of the appointment. |
| Add, update or remove the filter value of a resource |
Add, update or remove the filter value of a resource. |
| Add, update or remove the live location of a resource |
Add, update or remove the live location of a resource. |
| Add, update or remove the priority of an appointment |
Add, update or remove the priority of an appointment. |
| Add, update or remove the task's locked status |
Add, update or remove the task's locked status. |
| Add, update or remove the uri of a resource |
Add, update or remove the uri of a resource. |
Add, update or remove a calendar for a resource
Add, update or remove a calendar for a resource.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Code
|
code | string | ||
|
Resource no.
|
resourceNo | string | ||
|
Calendar code
|
calendarCode | string | ||
|
Start date
|
startDate | date-time | ||
|
End date
|
endDate | date-time |
Add, update or remove a caption
Add, update or remove a caption.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Context
|
context | integer | ||
|
Source table
|
sourceTable | string | ||
|
Field name
|
fieldName | string | ||
|
Language
|
language | string | ||
|
Text
|
text | string |
Add, update or remove a category
Add, update or remove a category, which is the visual indicator that renders the background of the appointment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Name
|
name | string | ||
|
Display name
|
displayName | string | ||
|
Color
|
color | string |
Add, update or remove a container
Add, update or remove a container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Name
|
name | string | ||
|
Handle date
|
handleDate | date-time | ||
|
Handle locked
|
handleLocked | boolean |
Add, update or remove a filter group
Add, update or remove a filter group.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Id
|
id | integer | ||
|
Name
|
name | string | ||
|
Column no.
|
columnNo | integer | ||
|
Date filter
|
dataFilter | boolean |
Add, update or remove a filter value
Add, update or remove a filter value.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Group
|
group | string | ||
|
Value
|
value | string |
Add, update or remove a job
Add, update or remove a job.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | True | string | |
|
Source type
|
sourceType | True | string | |
|
Job no.
|
jobNo | True | string | |
|
Short description
|
shortDescription | True | string | |
|
Description
|
description | string | ||
|
Type
|
type | string | ||
|
Name
|
name | string | ||
|
Category
|
category | string | ||
|
Time marker
|
timeMarker | string | ||
|
Pin
|
pin | string | ||
|
Customer no.
|
customerNo | string | ||
|
Customer name
|
customerName | string | ||
|
Customer address
|
customerAddress | string | ||
|
Customer address longitude
|
customerAddressGeoLong | string | ||
|
Customer address latitude
|
customerAddressGeoLat | string | ||
|
Customer phone
|
customerPhone | string | ||
|
Customer e-mail
|
customerEmail | |||
|
Contact no.
|
contactNo | string | ||
|
Contact name
|
contactName | string | ||
|
Contact address
|
contactAddress | string | ||
|
Contact address longitude
|
contactAddressGeoLong | string | ||
|
Contact address latitude
|
contactAddressGeoLat | string | ||
|
Contact phone
|
contactPhone | string | ||
|
Contact e-mail
|
contactEmail | |||
|
Site no.
|
siteNo | string | ||
|
Site name
|
siteName | string | ||
|
Site address
|
siteAddress | string | ||
|
Site address longitude
|
siteAddressGeoLong | string | ||
|
Site address latitude
|
siteAddressGeoLat | string | ||
|
Site phone
|
sitePhone | string | ||
|
Site e-mail
|
siteEmail | |||
|
Site region
|
siteRegion | string | ||
|
Site street
|
siteStreet | string | ||
|
Site street no.
|
siteStreetNo | string | ||
|
Site post code
|
sitePostcode | string | ||
|
Site city
|
siteCity | string | ||
|
Site county
|
siteCounty | string | ||
|
Site state
|
siteState | string | ||
|
Site country
|
siteCountry | string | ||
|
Site from no.
|
siteFromNo | string | ||
|
Site from name
|
siteFromName | string | ||
|
Site from address
|
siteFromAddress | string | ||
|
Site from longitude
|
siteFromAddressGeoLong | string | ||
|
Site from latitude
|
siteFromAddressGeoLat | string | ||
|
Site from phone
|
siteFromPhone | string | ||
|
Site from e-mail
|
siteFromEmail | |||
|
Site from region
|
siteFromRegion | string | ||
|
Site from street
|
siteFromStreet | string | ||
|
Site from street no.
|
siteFromStreetNo | string | ||
|
Site from post code
|
siteFromPostcode | string | ||
|
Site from city
|
siteFromCity | string | ||
|
Site from county
|
siteFromCounty | string | ||
|
Site from state
|
siteFromState | string | ||
|
Site from country
|
siteFromCountry | string | ||
|
Bill no.
|
billNo | string | ||
|
Bill name
|
billName | string | ||
|
Bill address
|
billAddress | string | ||
|
Bill address longitude
|
billAddressGeoLong | string | ||
|
Bill address latitude
|
billAddressGeoLat | string | ||
|
Bill phone
|
billPhone | string | ||
|
Bill e-mail
|
billEmail | |||
|
Bill region
|
billRegion | string | ||
|
Importance
|
importance | integer | ||
|
Creation datetime
|
creationDateTime | date-time | ||
|
Customer reference
|
customerReference | string | ||
|
Language
|
language | string | ||
|
Responsible
|
responsible | string | ||
|
Creator
|
creator | string | ||
|
Free text field #1
|
freeText1 | string | ||
|
Free text field #2
|
freeText2 | string | ||
|
Free text field #3
|
freeText3 | string | ||
|
Free text field #4
|
freeText4 | string | ||
|
Free text field #5
|
freeText5 | string | ||
|
Free text field #6
|
freeText6 | string | ||
|
Free text field #7
|
freeText7 | string | ||
|
Free text field #8
|
freeText8 | string | ||
|
Free text field #9
|
freeText9 | string | ||
|
Free text field #10
|
freeText10 | string | ||
|
Free text field #11
|
freeText11 | string | ||
|
Free text field #12
|
freeText12 | string | ||
|
Free text field #13
|
freeText13 | string | ||
|
Free text field #14
|
freeText14 | string | ||
|
Free text field #15
|
freeText15 | string | ||
|
Free text field #16
|
freeText16 | string | ||
|
Free text field #17
|
freeText17 | string | ||
|
Free text field #18
|
freeText18 | string | ||
|
Free text field #19
|
freeText19 | string | ||
|
Free text field #20
|
freeText20 | string | ||
|
Free decimal field #1
|
freeDecimal1 | double | ||
|
Free decimal field #2
|
freeDecimal2 | double | ||
|
Free decimal field #3
|
freeDecimal3 | double | ||
|
Free decimal field #4
|
freeDecimal4 | double | ||
|
Free decimal field #5
|
freeDecimal5 | double | ||
|
Free date field #1
|
freeDate1 | date-time | ||
|
Free date field #2
|
freeDate2 | date-time | ||
|
Free date field #3
|
freeDate3 | date-time | ||
|
Free date field #4
|
freeDate4 | date-time | ||
|
Free date field #5
|
freeDate5 | date-time | ||
|
Free boolean field #1
|
freeBit1 | boolean | ||
|
Free boolean field #2
|
freeBit2 | boolean | ||
|
Free boolean field #3
|
freeBit3 | boolean | ||
|
Free boolean field #4
|
freeBit4 | boolean | ||
|
Free boolean field #5
|
freeBit5 | boolean | ||
|
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 appointmetns
|
checkAppointments | boolean | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove a pin
Add, update or remove a pin, which is the visual indicator that renders the colors of the markers on the map.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Name
|
name | string | ||
|
Color
|
color | string |
Add, update or remove a resource
Add, update or remove a resource.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Resource no.
|
resourceNo | string | ||
|
Resource type
|
resourceType | string | ||
|
Resource type id
|
resourceTypeId | integer | ||
|
Resource name
|
resourceName | string | ||
|
Display name
|
displayName | string | ||
|
Department
|
department | string | ||
|
E-mail
|
||||
|
Phone
|
phone | string | ||
|
Mobile phone
|
mobilePhone | string | ||
|
Replacement resource
|
replacementResource | boolean | ||
|
Field service e-mail
|
fieldServiceEmail | |||
|
Person e-mail
|
personalEmail | |||
|
GPS tracking no.
|
gpsTrackingResourceNo | string | ||
|
Home address
|
homeAddress | string | ||
|
Home address longitude
|
homeAddressGeoLong | float | ||
|
Home address latitude
|
homeAddressGeoLat | float | ||
|
Home phone
|
homePhone | string | ||
|
Home e-mail
|
homeEmail | |||
|
Home street
|
homeStreet | string | ||
|
Home street no.
|
homeStreetNo | string | ||
|
Home post code
|
homePostcode | string | ||
|
Home city
|
homeCity | string | ||
|
Home county
|
homeCounty | string | ||
|
Home state
|
homeState | string | ||
|
Home country
|
homeCountry | string | ||
|
Home region
|
homeRegion | string | ||
|
Team code
|
teamCode | string | ||
|
Team name
|
teamName | string | ||
|
Team type
|
teamType | string | ||
|
Team sort
|
teamSort | integer | ||
|
Team member type
|
teamMemberType | string | ||
|
Team member sort
|
teamMemberSort | integer | ||
|
Do not show
|
doNotShow | boolean | ||
|
Enable exchange integration
|
exchangeIntegrationEnabled | boolean | ||
|
Enable resource GPS tracking
|
resourceGpsTrackingEnabled | boolean | ||
|
In service from
|
inServiceFrom | date-time | ||
|
In service until
|
inServiceTill | date-time | ||
|
URL 1
|
url1 | string | ||
|
URL description #1
|
urlDescription1 | string | ||
|
URL 2
|
url2 | string | ||
|
URL description #2
|
urlDescription2 | string | ||
|
URL 3
|
url3 | string | ||
|
URL description #3
|
urlDescription3 | string | ||
|
Bulk planning
|
bulkPlanning | boolean | ||
|
Bulk capacity
|
bulkCapacity | double | ||
|
The pin indicator
|
pin | string | ||
|
Free text field #1
|
freeText1 | string | ||
|
Free text field #2
|
freeText2 | string | ||
|
Free text field #3
|
freeText3 | string | ||
|
Free text field #4
|
freeText4 | string | ||
|
Free text field #5
|
freeText5 | string | ||
|
Free text field #6
|
freeText6 | string | ||
|
Free text field #7
|
freeText7 | string | ||
|
Free text field #8
|
freeText8 | string | ||
|
Free text field #9
|
freeText9 | string | ||
|
Free text field #10
|
freeText10 | string | ||
|
Free text field #11
|
freeText11 | string | ||
|
Free text field #12
|
freeText12 | string | ||
|
Free text field #13
|
freeText13 | string | ||
|
Free text field #14
|
freeText14 | string | ||
|
Free text field #15
|
freeText15 | string | ||
|
Free text field #16
|
freeText16 | string | ||
|
Free text field #17
|
freeText17 | string | ||
|
Free text field #18
|
freeText18 | string | ||
|
Free text field #19
|
freeText19 | string | ||
|
Free text field #20
|
freeText20 | string | ||
|
Free decimal field #1
|
freeDecimal1 | double | ||
|
Free decimal field #2
|
freeDecimal2 | double | ||
|
Free decimal field #3
|
freeDecimal3 | double | ||
|
Free decimal field #4
|
freeDecimal4 | double | ||
|
Free decimal field #5
|
freeDecimal5 | double | ||
|
Free decimal field #1
|
freeDate1 | date-time | ||
|
Free decimal field #2
|
freeDate2 | date-time | ||
|
Free decimal field #3
|
freeDate3 | date-time | ||
|
Free decimal field #4
|
freeDate4 | date-time | ||
|
Free decimal field #5
|
freeDate5 | date-time | ||
|
Free boolean field #1
|
freeBit1 | boolean | ||
|
Free boolean field #2
|
freeBit2 | boolean | ||
|
Free boolean field #3
|
freeBit3 | boolean | ||
|
Free boolean field #4
|
freeBit4 | boolean | ||
|
Free boolean field #5
|
freeBit5 | boolean |
Add, update or remove a task
Add, update or remove a task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Job no.
|
jobNo | string | ||
|
Task no.
|
taskNo | string | ||
|
Task type
|
taskType | integer | ||
|
Short description
|
shortDescription | string | ||
|
Description
|
description | string | ||
|
Name
|
name | string | ||
|
Type
|
type | string | ||
|
Category
|
category | string | ||
|
Time marker
|
timeMarker | string | ||
|
Pin
|
pin | string | ||
|
Service no.
|
serviceNo | string | ||
|
Service group
|
serviceGroup | string | ||
|
Service class
|
serviceClass | string | ||
|
Service serial no.
|
serviceSerialNo | string | ||
|
Service name
|
serviceName | string | ||
|
IRIS fault
|
irisFault | string | ||
|
IRIS symptom
|
irisSymptom | string | ||
|
IRIS area
|
irisArea | string | ||
|
IRIS reason
|
irisReason | string | ||
|
IRIS resolution
|
irisResolution | string | ||
|
Skill #1
|
skill1 | string | ||
|
Skill #2
|
skill2 | string | ||
|
Skill #3
|
skill3 | string | ||
|
Contract number
|
contractNo | string | ||
|
Contract type
|
contractType | string | ||
|
Contract description
|
contractDescription | string | ||
|
Contract start date
|
contractStartDate | date-time | ||
|
Contract end date
|
contractEndDate | date-time | ||
|
Parts warranty start date
|
partsWarrantyStartDate | date-time | ||
|
Parts warranty end date
|
partsWarrantyEndDate | date-time | ||
|
Labor warranty start date
|
laborWarrantyStartDate | date-time | ||
|
Labor warranty end date
|
laborWarrantyEndDate | date-time | ||
|
Importance
|
importance | integer | ||
|
Status
|
status | string | ||
|
Expected response date
|
expectedResponseDateTime | date-time | ||
|
Actual response date
|
actualResponseDateTime | date-time | ||
|
Requested start date
|
requestedStartDate | date-time | ||
|
Requested end date
|
requestedEndDate | date-time | ||
|
Requested start time
|
requestedStartTime | string | ||
|
Requested end time
|
requestedEndTime | string | ||
|
Confirmed start date
|
confirmedStartDate | date-time | ||
|
Confirmed end date
|
confirmedEndDate | date-time | ||
|
Actual start date
|
actualStartDate | date-time | ||
|
Actual end date
|
actualEndDate | date-time | ||
|
Location description
|
locationDescription | string | ||
|
Duration
|
duration | string | ||
|
Duration in seconds
|
durationInSeconds | integer | ||
|
Subject
|
subject | string | ||
|
Body
|
body | string | ||
|
Is infinite task
|
infiniteTask | boolean | ||
|
Open the task from
|
taskOpenAsOf | date-time | ||
|
Open the task until
|
taskOpenTill | date-time | ||
|
Required total duration
|
requiredTotalDuration | string | ||
|
Required number of resources
|
requiredNoResources | integer | ||
|
Earliest allowed time
|
appointmentEarliestAllowed | date-time | ||
|
Latest allowed time
|
appointmentLatestAllowed | date-time | ||
|
Free text field #1
|
freeText1 | string | ||
|
Free text field #2
|
freeText2 | string | ||
|
Free text field #3
|
freeText3 | string | ||
|
Free text field #4
|
freeText4 | string | ||
|
Free text field #5
|
freeText5 | string | ||
|
Free text field #6
|
freeText6 | string | ||
|
Free text field #7
|
freeText7 | string | ||
|
Free text field #8
|
freeText8 | string | ||
|
Free text field #9
|
freeText9 | string | ||
|
Free text field #10
|
freeText10 | string | ||
|
Free text field #11
|
freeText11 | string | ||
|
Free text field #12
|
freeText12 | string | ||
|
Free text field #13
|
freeText13 | string | ||
|
Free text field #14
|
freeText14 | string | ||
|
Free text field #15
|
freeText15 | string | ||
|
Free text field #16
|
freeText16 | string | ||
|
Free text field #17
|
freeText17 | string | ||
|
Free text field #18
|
freeText18 | string | ||
|
Free text field #19
|
freeText19 | string | ||
|
Free text field #20
|
freeText20 | string | ||
|
Free decimal field #1
|
freeDecimal1 | double | ||
|
Free decimal field #2
|
freeDecimal2 | double | ||
|
Free decimal field #3
|
freeDecimal3 | double | ||
|
Free decimal field #4
|
freeDecimal4 | double | ||
|
Free decimal field #5
|
freeDecimal5 | double | ||
|
Free date field #1
|
freeDate1 | date-time | ||
|
Free date field #2
|
freeDate2 | date-time | ||
|
Free date field #3
|
freeDate3 | date-time | ||
|
Free date field #4
|
freeDate4 | date-time | ||
|
Free date field #5
|
freeDate5 | date-time | ||
|
Free boolean field #1
|
freeBit1 | boolean | ||
|
Free boolean field #2
|
freeBit2 | boolean | ||
|
Free boolean field #3
|
freeBit3 | boolean | ||
|
Free boolean field #4
|
freeBit4 | boolean | ||
|
Free boolean field #5
|
freeBit5 | boolean | ||
|
URL 1
|
url1 | string | ||
|
URL 1 description
|
urlDescription1 | string | ||
|
URL 2
|
url2 | string | ||
|
URL 2 description
|
urlDescription2 | string | ||
|
URL 3
|
url3 | string | ||
|
URL 3 description
|
urlDescription3 | string | ||
|
Certificate no.
|
certificateNo | string | ||
|
Required total duration (in seconds)
|
requiredTotalDurationInSeconds | integer | ||
|
Do not count appointment resources
|
doNotCountAppointmentResource | boolean | ||
|
Is complete
|
isComplete | boolean | ||
|
Planning UOM
|
planningUOM | string | ||
|
Planning UOM conversion
|
planningUOMConversion | double | ||
|
Planning quantity
|
planningQty | double | ||
|
Use fixed planning quantity
|
useFixPlanningQty | boolean | ||
|
Round to UOM
|
roundToUOM | boolean | ||
|
Appointment template
|
appointmentTemplate | string | ||
|
Bulk planning quantity
|
bulkPlanningQty | double | ||
|
Start date
|
startDate | date-time | ||
|
End date
|
endDate | date-time | ||
|
Percentage done
|
percentDone | integer | ||
|
Scheduling mode
|
schedulingMode | integer | ||
|
Baseline start date
|
baseLineStartDate | date-time | ||
|
Baseline end date
|
baseLineEndDate | date-time | ||
|
Baseline percent done
|
baseLinePercentDone | integer | ||
|
Deadline
|
deadLine | date-time | ||
|
Index
|
index | integer | ||
|
Constraint type
|
constraintType | integer | ||
|
Constraint datetime
|
constraintDatetime | date-time | ||
|
Parent task no.
|
parentTaskNo | string | ||
|
Calendar code
|
calendarCode | string | ||
|
Predecessor task no.
|
predecessorTaskNo | string | ||
|
Predecessor lag
|
predecessorLag | integer | ||
|
Manually scheduled
|
manuallyScheduled | boolean | ||
|
Note
|
note | string | ||
|
Overrule Gantt planning
|
overRuleGanttPlanning | boolean | ||
|
Ignore calendars
|
ignoreCalendars | boolean | ||
|
Container name
|
containerName | string | ||
|
Container index
|
containerIndex | integer | ||
|
Check appointments
|
checkAppointments | boolean | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove a task container
Add, update or remove a task container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Job no.
|
jobNo | string | ||
|
Task no.
|
taskNo | string | ||
|
name
|
name | string | ||
|
Index
|
index | integer |
Add, update or remove a task filter value
Add, update or remove a task filter value.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Job no.
|
jobNo | string | ||
|
Task no.
|
taskNo | string | ||
|
Filter group
|
filterGroup | string | ||
|
Filter value
|
filterValue | string | ||
|
Transfer to temp
|
transferToTemp | boolean |
Add, update or remove a time marker
Add, update or remove a time marker, which is the visual indicator that renders the underscore of the appointment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Name
|
name | string | ||
|
Color
|
color | string |
Add, update or remove an action link
Add, update or remove an action link.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
URI type
|
uriType | integer | ||
|
URI
|
uri | string | ||
|
Description
|
description | string | ||
|
Default
|
default | boolean |
Add, update or remove an appointment
Add, update or remove an appointment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Appointment id
|
appointmentId | integer | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Job no.
|
jobNo | string | ||
|
Task no.
|
taskNo | string | ||
|
Resource no.
|
resourceNo | string | ||
|
Subject
|
subject | string | ||
|
Body
|
body | string | ||
|
Start
|
start | date-time | ||
|
End
|
end | date-time | ||
|
Is all day
|
isAllDay | boolean | ||
|
Time marker
|
timeMarker | string | ||
|
Category
|
category | string | ||
|
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 |
Add, update or remove an appointment container
Add, update or remove an appointment container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Container
|
container | string | ||
|
Appointment
|
appointment | string |
Add, update or remove an appointment link
Add, update or remove an appointment link.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
URI
|
uri | string | ||
|
Description
|
description | string |
Add, update or remove an assignment
Add, update or remove an assignment, which is the allocation of a resource to an appointment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Resource no.
|
resourceNo | string | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove notification
Add, update or remove notification.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Connector id
|
connectorId | string | ||
|
Type
|
type | integer | ||
|
Code
|
code | string | ||
|
Text
|
text | string | ||
|
Date
|
date | date-time | ||
|
Job no.
|
jobNo | string | ||
|
Task no.
|
taskNo | string | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove the appointment's locked status
Add, update or remove the appointment's locked status.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Locked
|
locked | boolean | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove the appointment's planning quantity
Add, update or remove the appointment's planning quantity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Quantity
|
quantity | double | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove the appointment's time marker
Add, update or remove the appointment's time marker.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Time marker
|
timeMarker | string | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove the capacity of a resource
Add, update or remove the capacity of a resource.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Resource no.
|
resourceNo | string | ||
|
Date
|
date | date-time | ||
|
Capacity in seconds
|
capacityInSeconds | integer | ||
|
Quantity
|
quantity | double | ||
|
Unit of measure
|
unitOfMeasure | string | ||
|
Unit of measure conversion
|
unitOfMeasureConversion | double |
Add, update or remove the category of an appointment
Add, update or remove the category of an appointment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Category
|
category | string | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove the content of the appointment
Add, update or remove the content of the appointment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Sent from back-office
|
sentFromBackOffice | boolean | ||
|
Subject
|
subject | string | ||
|
Body
|
body | string |
Add, update or remove the filter value of a resource
Add, update or remove the filter value of a resource.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Resource no.
|
resourceNo | string | ||
|
Filter group
|
filterGroup | string | ||
|
Filter value
|
filterValue | string | ||
|
Transfer to temp
|
transferToTemp | boolean |
Add, update or remove the live location of a resource
Add, update or remove the live location of a resource.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Resource no.
|
resourceNo | string | ||
|
GPS tracking resource no.
|
gpsTrackingResourceNo | string | ||
|
Latitude
|
latitude | double | ||
|
Longitude
|
longitude | double | ||
|
Speed
|
speed | integer | ||
|
Date
|
date | date-time | ||
|
Row id
|
rowId | string | ||
|
Power
|
power | string |
Add, update or remove the priority of an appointment
Add, update or remove the priority of an appointment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Appointment id
|
appointmentId | integer | ||
|
Importance
|
importance | integer | ||
|
Appointment GUID
|
appointmentGuid | uuid | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove the task's locked status
Add, update or remove the task's locked status.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Source application
|
sourceApp | string | ||
|
Source type
|
sourceType | string | ||
|
Job no.
|
jobNo | string | ||
|
Task no.
|
taskNo | string | ||
|
Locked
|
locked | boolean | ||
|
Sent from back-office
|
sentFromBackOffice | boolean |
Add, update or remove the uri of a resource
Add, update or remove the uri of a resource.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Append
|
ds-append | boolean |
True to create or update the record, false to remove. |
|
|
Resource no.
|
resourceNo | string | ||
|
URI
|
uri | string | ||
|
Description
|
description | string |