Methods
-
Will add a new reminder event to the part
-
Name Type Description requestAppearition.Part.Reminder.AddPartReminderRequest Contains the details of the Reminder
requestOptionsAppearition.RequestOptions Contains the various callback methods for this request
-
Appearition.Part.Reminder.GetPartReminders (partId, requestOptions)Array.<Appearition.Part.Manage.PartReminder> static
Will retrieve all the reminder events for the given part
-
Name Type Description partIdnumber Unique identifier of the part
requestOptionsAppearition.RequestOptions Contains the various callback methods for this request
Returns:
Type Description Array.<Appearition.Part.Manage.PartReminder> This is returned as part of the success callback function in the requestOptions param -
Will modify the details of an existing reminder event for a part. Note, depending on the request properties, this method could also modify the reminder details on existing assets in the database which are of this part type
-
Name Type Description requestAppearition.Part.Reminder.UpdatePartReminderRequest Contains the details of the Reminder
requestOptionsAppearition.RequestOptions Contains the various callback methods for this request
Type Definitions
-
This data structure is posted to the server when adding a new Reminder to a part
-
Properties:
Name Type Description ProjectIdnumber Uniquely identifies the project (aka channel)
PartIdnumber Uniquely identifies the part. Required
StopDatestring If the reminders are recurring, this is the date when the event notifications should stop
Commentsstring The text that is sent as part of the notification
IsEmailReminderboolean Indicates if the notification should be made via email
IsExceptionItemRaisedboolean Indicates if an asset exception record should be created for this event
ReminderEmailsstring If IsEmailReminder=true, this holds a comma separated list of email addresses that need to receive the notification
DefaultPartInstanceReminderboolean Is used when creating or editing reminders. If set to true, then this reminder will be automatically assigned to each new instance of this part in the asset database.
UpdatePartInstanceReminderboolean Is used when creating or editing reminders. If set to true, then the system will automatically update ALL existing instances of this part and set the reminder on them.
FirstReminderDateIntervalTypeAppearition.Part.Manage.FirstReminderDateIntervalTypeEnum Relates to the first reminder. It is the numerical value of the FirstReminderDateIntervalTypeEnum (e.g. before)
FirstReminderDateIntervalRecurranceTypeAppearition.Part.Manage.RecurranceEnum Relates to the first reminder. It is the numerical value of the RecurranceEnum (e.g. days).
FirstReminderDateIntervalnumber Relates to the first reminder. Is the number of days, weeks, etc (i.e. FirstReminderDateIntervalRecurranceType) before or after (i.e. FirstReminderDateIntervalType) the date of reminder (i.e. FirstReminderDateType)
FirstReminderDateTypeAppearition.Part.Manage.ReminderDateTypeEnum Relates to the first reminder. It is the numerical value of the ReminderDateTypeEnum. (e.g. PurchaseDate)
RecurranceTypeAppearition.Part.Manage.RecurranceEnum Relates to repeating reminders and indicates whether they happen daily, weekly, etc. It is the numerical value of the RecurranceEnum.
RecurranceValuenumber If this reminder needs to repeat, this holds the number of times the reminders will happen per RecurranceType. (e.g. repeat every 3 days)
IsOnceboolean Indicates if only one reminder should be made
-
This data structure is posted to the server when modifying an existing Reminder for a part
-
Properties:
Name Type Description ProjectIdnumber Uniquely identifies the project (aka channel). Required
Idnumber Uniquely identifies the reminder record. Required
PartIdnumber Uniquely identifies the part. Required
StopDatestring If the reminders are recurring, this is the date when the event notifications should stop
Commentsstring The text that is sent as part of the notification
IsEmailReminderboolean Indicates if the notification should be made via email
IsExceptionItemRaisedboolean Indicates if an asset exception record should be created for this event
ReminderEmailsstring If IsEmailReminder=true, this holds a comma separated list of email addresses that need to receive the notification
DefaultPartInstanceReminderboolean Is used when creating or editing reminders. If set to true, then this reminder will be automatically assigned to each new instance of this part in the asset database.
UpdatePartInstanceReminderboolean Is used when creating or editing reminders. If set to true, then the system will automatically update ALL existing instances of this part and set the reminder on them.
FirstReminderDateTypeAppearition.Part.Manage.ReminderDateTypeEnum Relates to the first reminder. It is the numerical value of the ReminderDateTypeEnum. (e.g. PurchaseDate)
FirstReminderDateIntervalTypeAppearition.Part.Manage.FirstReminderDateIntervalTypeEnum Relates to the first reminder. It is the numerical value of the FirstReminderDateIntervalTypeEnum (e.g. before)
FirstReminderDateIntervalRecurranceTypeAppearition.Part.Manage.RecurranceEnum Relates to the first reminder. It is the numerical value of the RecurranceEnum (e.g. days).
FirstReminderDateIntervalnumber Relates to the first reminder. Is the number of days, weeks, etc (i.e. FirstReminderDateIntervalRecurranceType) before or after (i.e. FirstReminderDateIntervalType) the date of reminder (i.e. FirstReminderDateType)
RecurranceTypeAppearition.Part.Manage.RecurranceEnum Relates to repeating reminders and indicates whether they happen daily, weekly, etc. It is the numerical value of the RecurranceEnum.
RecurranceValuenumber If this reminder needs to repeat, this holds the number of times the reminders will happen per RecurranceType. (e.g. repeat every 3 days)
IsOnceboolean Indicates if only one reminder should be made