Namespace: Manage

Methods

Appearition.Asset.Manage.AddPartInstance (request, requestOptions)Appearition.Asset.PartInstanceViewModel static

Creates a new instance of a part at the given site (i.e. new asset)

Name	Type	Description
request	Appearition.Asset.Manage.AddPartInstanceRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

Type	Description
Appearition.Asset.PartInstanceViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.Manage.AddPartInstanceReminder (request, requestOptions) static

Will add a reminder event to an existing asset

Name	Type	Description
request	Appearition.Asset.Manage.AddPartInstanceReminderRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.AddPartToSite (request, requestOptions) static

Will associate the given part to an existing site and set stock level thresholds

Name	Type	Description
request	Appearition.Asset.Manage.AddPartToSiteRequest	Contains the details of the part and site and thresholds
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.AddSubpartInstance (request, requestOptions)Appearition.Asset.PartInstanceViewModel static

Will link an existing asset (i.e. request.SubPartInstanceId) as a child of another existing asset (i.e. request.PartInstanceId)

Name	Type	Description
request	Appearition.Asset.Manage.AddSubPartInstanceRequest	Contains the details of the existing assets being linked together
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

Type	Description
Appearition.Asset.PartInstanceViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.Manage.CreatePartInstancesReminders (request, requestOptions) static

Will add reminder events to all existing assets that are of a particular type of part. If the reminder exists on the part, any changes will be updated. If the reminder does not exist, it will be created and added to the part. Note if the request.UpdatePartInstanceReminder is set to true, then all existing assets of this type of part will be updated to include the new reminder event.

Name	Type	Description
request	Appearition.Asset.Manage.CreatePartInstancesRemindersRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.DeletePartInstance (request, requestOptions) static

Deletes an asset (i.e. part instance) from the database. A comment must be provided for audit purposes

Name	Type	Description
request	Appearition.Asset.Manage.DeletePartInstanceRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.DeleteSubPartInstance (request, requestOptions) static

Will unlink a child asset from its parent

Name	Type	Description
request	Appearition.Asset.Manage.DeleteSubPartInstanceRequest	Contains the details of the assets being unlinked
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.MovePartInstanceFromRepairer (request, requestOptions) static

Will move an asset back from a repairer to a depot

Name	Type	Description
request	Appearition.Asset.Manage.MovePartInstanceFromRepairerRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.MovePartInstanceToRepairer (request, requestOptions) static

Will move an asset to a repairer site

Name	Type	Description
request	Appearition.Asset.Manage.MovePartInstanceToRepairerRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.RemovePartFromSite (request, requestOptions) static

Will disassociate the part from the site. This can only happen when there is no stock for the combination of part, part status and site

Name	Type	Description
request	Appearition.Asset.Manage.RemovePartFromSiteRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.UpdatePart (request, requestOptions) Deprecated : The Appearition.Part.Manage module has an update part method which in the future will be extended to handle the extra update fields that this method performs static

Will update the details of a part. Deprecated.

Name	Type	Description
request	Appearition.Asset.Manage.UpdatePartRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.UpdatePartInstance (request, requestOptions) static

Will modify the details of an asset in the database

Name	Type	Description
request	Appearition.Asset.Manage.UpdatePartInstanceRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.UpdatePartInstanceReminder (request, requestOptions) static

Will update an existing reminder event on an existing asset

Name	Type	Description
request	Appearition.Asset.Manage.UpdatePartInstanceReminderRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.UpdatePartInstanceSite (request, requestOptions) static

Will move an asset to a different site

Name	Type	Description
request	Appearition.Asset.Manage.UpdatePartInstanceSiteRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.UpdatePartInstancesReminders (request, requestOptions) static

This method will update the details of existing asset reminder events. If the request.PartReminderUpdateRecord property is true, the existing reminder record on the part will be updated, otherwise a new reminder record will be created for the part. Note, if the request.UpdatePartInstanceReminder is set to true, then all existing assets of this type of part will be updated to include the changes to the reminder event.

Name	Type	Description
request	Appearition.Asset.Manage.UpdatePartInstancesRemindersRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.UpdatePartInstanceStatus (request, requestOptions) static

Will modify the status of an asset in the database

Name	Type	Description
request	Appearition.Asset.Manage.UpdatePartInstanceStatusRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Asset.Manage.UpdateSitePart (request, requestOptions) static

Updates the stock count and threshold levels for a part and a particular part status at a particular site.

Name	Type	Description
request	Appearition.Asset.Manage.UpdateSitePartRequest	Contains the details required to complete this action
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Type Definitions

Appearition.Asset.Manage.AddPartInstanceReminderRequest

This data structure is posted to the server when creating a new reminder event for an existing asset

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset. Required
PartId	number	Uniquely identifies the part. Required
StopDate	string	If the reminders are recurring, this is the date when the event notifications should stop
Comments	string	The text that is sent as part of the notification
IsEmailReminder	boolean	Indicates if the notification should be made via email
IsExceptionItemRaised	boolean	Indicates if an asset exception record should be created for this event
ReminderEmails	string	If IsEmailReminder=true, this holds a comma separated list of email addresses that need to receive the notification
FirstReminderDate	string	The date when the first event notifications will happen
RecurranceType	Appearition.Part.Manage.RecurranceEnum	Relates to repeating reminders and indicates whether they happen daily, weekly, etc. It is the numerical value of the RecurranceEnum.
RecurranceValue	number	If this reminder needs to repeat, this holds the number of times the reminders will happen per RecurranceType. (e.g. repeat every 3 days)
IsOnce	boolean	Indicates if only one reminder should be made
PartName	string	The name of the part
Barcode	string	The name of the part
SerialNo	string	The name of the part

Appearition.Asset.Manage.AddPartInstanceRequest

This data structure is posted to the server when creating a new asset

Properties:

Name	Type	Description
SiteId	number	Uniquely identifies the site. Required
PartId	number	Uniquely identifies the part. Required
PartStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum. Stock levels are based on functional status of a part, hence the same site and part can have different stock levels for different part states
JobAssignmentFormFieldId	number	If this action was initiated as part of a submitted form, this property is the unique identifier to the specific field on that form which registered the action.
Barcode	string	Is an identifier of this asset
SerialNo	string	Is an identifier of this asset
DateOfPurchase	string	The date when this asset was purchased
WarrantyExpiryDate	string	The date when the warranty on this asset will expire
Comment	string	Arbitrary text about this asset
ManufacturerId	string	Unique identifier of the manufacturer listed against this asset
ManufacturerModelId	string	Unique identifier of the model record listed against this asset
RepairerId	number	Unique identifier of the repairer for this asset
SupplierId	number	Unique identifier of the supplier for this asset

Appearition.Asset.Manage.AddPartToSiteRequest

This data structure is posted to the server when associating a part to a site and setting stock level thresholds.

Properties:

Name	Type	Description
SiteId	number	Uniquely identifies the site. Required
PartId	number	Uniquely identifies the part. Required
StockCount	number	The existing number of stock at the site. Required, can be zero
PartStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum. Stock levels are based on functional status of a part, hence the same site and part can have different stock levels for different part states
MinCount	number	The minimum number of items that must be in stock. Required, can be zero and cannot be greater than MaxCount
MaxCount	number	The maximum number of items that can be in stock. Required and cannot be less than MinCount

Appearition.Asset.Manage.AddSubPartInstanceRequest

This data structure is posted to the server when linking an existing asset as a child of another.

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset which is the parent. Required.
SubPartInstanceId	number	Uniquely identifies the asset which is the child. Required.
ParentStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum. Represents the Part Status of the parent asset
SubPartId	number	Uniquely identifies the part of the child asset
JobAssignmentFormFieldId	number	If this action was initiated as part of a submitted form, this property is the unique identifier to the specific field on that form which registered the action.

Appearition.Asset.Manage.CreatePartInstancesRemindersRequest

This data structure is posted to the server when creating new reminder events on all existing assets of particular type of part

Properties:

Name	Type	Description
Id	number	Uniquely identifies the reminder record that has been configured as part of part management
PartId	number	Uniquely identifies the part. Required
StopDate	string	If the reminders are recurring, this is the date when the event notifications should stop
Comments	string	The text that is sent as part of the notification
IsEmailReminder	boolean	Indicates if the notification should be made via email
IsExceptionItemRaised	boolean	Indicates if an asset exception record should be created for this event
ReminderEmails	string	If IsEmailReminder=true, this holds a comma separated list of email addresses that need to receive the notification
DefaultPartInstanceReminder	boolean	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.
UpdatePartInstanceReminder	boolean	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.
FirstReminderDateType	Appearition.Part.Manage.ReminderDateTypeEnum	Relates to the first reminder. It is the numerical value of the ReminderDateTypeEnum. (e.g. PurchaseDate)
FirstReminderDateIntervalType	Appearition.Part.Manage.FirstReminderDateIntervalTypeEnum	Relates to the first reminder. It is the numerical value of the FirstReminderDateIntervalTypeEnum (e.g. before)
FirstReminderDateIntervalRecurranceType	Appearition.Part.Manage.RecurranceEnum	Relates to the first reminder. It is the numerical value of the RecurranceEnum (e.g. days).
FirstReminderDateInterval	number	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)
RecurranceType	Appearition.Part.Manage.RecurranceEnum	Relates to repeating reminders and indicates whether they happen daily, weekly, etc. It is the numerical value of the RecurranceEnum.
RecurranceValue	number	If this reminder needs to repeat, this holds the number of times the reminders will happen per RecurranceType. (e.g. repeat every 3 days)
IsOnce	boolean	Indicates if only one reminder should be made
PartReminderUpdateRecord	boolean	Directs if the reminder event exists on the part and that it should be updated (i.e. true) or if a new reminder event should be created against the part (i.e. false).

Appearition.Asset.Manage.DeletePartInstanceRequest

This data structure is posted to the server when deleting an asset

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset. Required
DeleteComment	string	Text explaining why the asset is being deleted. Requires minimum of 5 characters

Appearition.Asset.Manage.DeleteSubPartInstanceRequest

This data structure is posted to the server when unlinking an existing asset from its parent asset.

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset which is the parent. Required.
SubPartInstanceId	number	Uniquely identifies the asset which is the child. Required.
Id	number	Same as SubPartInstanceId.

Appearition.Asset.Manage.MovePartInstanceFromRepairerRequest

This data structure is posted to the server when moving an asset back from a repairer and to a depot

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset. Required
JobAssignmentFormFieldId	number	If this action was initiated as part of a submitted form, this property is the unique identifier to the specific field on that form which registered the action.
NewSiteId	number	Uniquely identifies the new site that the asset is going to. Represents a site where the ShelterType is a depot (refer to Appearition.Site.Manage.SiteViewModel and Appearition.Site.ShelterTypeEnum)

Appearition.Asset.Manage.MovePartInstanceToRepairerRequest

This data structure is posted to the server when moving an asset to a repairer site

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset. Required
JobAssignmentFormFieldId	number	If this action was initiated as part of a submitted form, this property is the unique identifier to the specific field on that form which registered the action.
NewSiteId	number	Uniquely identifies the new site that the asset is going to. Represents a site where the ShelterType is a repairer (refer to Appearition.Site.Manage.SiteViewModel and Appearition.Site.ShelterTypeEnum)

Appearition.Asset.Manage.RemovePartFromSiteRequest

This data structure is posted to the server when disassociating a part from a site.

Properties:

Name	Type	Description
SiteId	number	Uniquely identifies the site. Required
PartId	number	Uniquely identifies the part. Required
PartStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum. Stock levels are based on functional status of a part, hence the same site and part can have different stock levels for different part states

Appearition.Asset.Manage.UpdatePartInstanceReminderRequest

This data structure is posted to the server when updating an existing reminder event on an asset

Properties:

Name	Type	Description
Id	number	Uniquely identifies the reminder record in the database. Required
StopDate	string	If the reminders are recurring, this is the date when the event notifications should stop
Comments	string	The text that is sent as part of the notification
IsEmailReminder	boolean	Indicates if the notification should be made via email
IsExceptionItemRaised	boolean	Indicates if an asset exception record should be created for this event
ReminderEmails	string	If IsEmailReminder=true, this holds a comma separated list of email addresses that need to receive the notification
FirstReminderDate	string	The date when the first event notifications will happen
RecurranceType	Appearition.Part.Manage.RecurranceEnum	Relates to repeating reminders and indicates whether they happen daily, weekly, etc. It is the numerical value of the RecurranceEnum.
RecurranceValue	number	If this reminder needs to repeat, this holds the number of times the reminders will happen per RecurranceType. (e.g. repeat every 3 days)
IsOnce	boolean	Indicates if only one reminder should be made
PartName	string	The name of the part
Barcode	string	The name of the part
SerialNo	string	The name of the part

Appearition.Asset.Manage.UpdatePartInstanceRequest

This data structure is posted to the server when deleting an asset

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset. Required
Barcode	string	Is an identifier of this asset
SerialNo	string	Is an identifier of this asset
DateOfPurchase	string	The date when this asset was purchased
WarrantyExpiryDate	string	The date when the warranty on this asset will expire
Comment	string	Arbitrary text about this asset
ManufacturerId	string	Unique identifier of the manufacturer listed against this asset
ManufacturerModelId	string	Unique identifier of the model record listed against this asset
RepairerId	number	Unique identifier of the repairer for this asset
SupplierId	number	Unique identifier of the supplier for this asset
JobAssignmentFormFieldId	number	If this action was initiated as part of a submitted form, this property is the unique identifier to the specific field on that form which registered the action.
SiteId	number	Uniquely identifies the site.

Appearition.Asset.Manage.UpdatePartInstanceSiteRequest

This data structure is posted to the server when moving an asset to another site

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset. Required
JobAssignmentFormFieldId	number	If this action was initiated as part of a submitted form, this property is the unique identifier to the specific field on that form which registered the action.
NewSiteId	number	Uniquely identifies the new site that the asset is going to

Appearition.Asset.Manage.UpdatePartInstancesRemindersRequest

This data structure is posted to the server when creating new reminder events on all existing assets of particular type of part

Properties:

Name	Type	Description
Id	number	Uniquely identifies the reminder record that has been configured as part of part management
PartId	number	Uniquely identifies the part. Required
StopDate	string	If the reminders are recurring, this is the date when the event notifications should stop
Comments	string	The text that is sent as part of the notification
IsEmailReminder	boolean	Indicates if the notification should be made via email
IsExceptionItemRaised	boolean	Indicates if an asset exception record should be created for this event
ReminderEmails	string	If IsEmailReminder=true, this holds a comma separated list of email addresses that need to receive the notification
DefaultPartInstanceReminder	boolean	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.
UpdatePartInstanceReminder	boolean	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.
FirstReminderDateType	Appearition.Part.Manage.ReminderDateTypeEnum	Relates to the first reminder. It is the numerical value of the ReminderDateTypeEnum. (e.g. PurchaseDate)
FirstReminderDateIntervalType	Appearition.Part.Manage.FirstReminderDateIntervalTypeEnum	Relates to the first reminder. It is the numerical value of the FirstReminderDateIntervalTypeEnum (e.g. before)
FirstReminderDateIntervalRecurranceType	Appearition.Part.Manage.RecurranceEnum	Relates to the first reminder. It is the numerical value of the RecurranceEnum (e.g. days).
FirstReminderDateInterval	number	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)
RecurranceType	Appearition.Part.Manage.RecurranceEnum	Relates to repeating reminders and indicates whether they happen daily, weekly, etc. It is the numerical value of the RecurranceEnum.
RecurranceValue	number	If this reminder needs to repeat, this holds the number of times the reminders will happen per RecurranceType. (e.g. repeat every 3 days)
IsOnce	boolean	Indicates if only one reminder should be made
PartReminderUpdateRecord	boolean	Directs if the reminder event exists on the part and that it should be updated (i.e. true) or if a new reminder event should be created against the part (i.e. false).

Appearition.Asset.Manage.UpdatePartInstanceStatusRequest

This data structure is posted to the server when updating the part status of an asset

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset. Required
JobAssignmentFormFieldId	number	If this action was initiated as part of a submitted form, this property is the unique identifier to the specific field on that form which registered the action.
NewPartStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum.

Appearition.Asset.Manage.UpdatePartRequest

This data structure is posted to the server when updating part information

Properties:

Name	Type	Description
Id	number	Uniquely identifies the part. Required
PartName	string	The name of the part. Required
EquipmentIdentifier	string	A property of part
Description	string	A property of part

Appearition.Asset.Manage.UpdateSitePartRequest

This data structure is posted to the server when updating stock threshold levels

Properties:

Name	Type	Description
SiteId	number	Uniquely identifies the site. Required
PartId	number	Uniquely identifies the part. Required
PartStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum. Stock levels are based on functional status of a part, hence the same site and part can have different stock levels for different part states
StockCount	number	The existing number of stock at the site. Required, can be zero
MinCount	number	The minimum number of items that must be in stock. Required, can be zero and cannot be greater than MaxCount
MaxCount	number	The maximum number of items that can be in stock. Required and cannot be less than MinCount