Tip: You can use filters for better results
What are Interface Actions?
Interface Actions are a set of predefined operations or functions meant to simplify interacting with our system through Mappings. The Interface Actions are available as Incoming Mapping goals in the legacy Incoming Mapping editor, and in the Python Mapping scripts through the fcinterface module.
Below you can find the list of all available Interface Actions with explanation and their expected parameters.
Create Ticket
This action creates a Ticket using the given parameter values.
ticket: { – wrapper object for ticket/workorder information, mandatory cne: str – external identifier for the ticket, mandatory reference: str – alias for cne project: str – name of the target project, mandatory category: str – enumeration of the ticket category, mandatory request: str – request description, mandatory specificationReference: str subcategory: str – enumeration of the ticket subcategory shortDescription: str diagnose: str coverageCode: str initialReference: str – external identifier for the parent case initialCreationDate: fcdatetime preferredAppointment: fcdatetime esdt: fcdatetime lsdt: fcdatetime customerLsdt: fcdatetime sla: str estimatedDuration: int priority: int vip: bool escalation: bool escalationReason: str customerSpecial: str customField1: customField1Value – Ticket custom fields are supported}device: { – wrapper object for device information serial: str assetTag: str barCode: str type: str model: str supplier: str purchased: fcdate manufactured: fcdate warrantyType: str warrantyStart: fcdate warrantyEnd: fcdate inWarranty: bool hostname: str mac: str os: str bundleTag: str note: str owner: str category: str subCategory: str customField1: customField1Value – Device custom fields are supported}affected: { – wrapper object for contact information, mandatory company: str additional: str salutation: str firstName: str – First name of the contact person lastName: str – Last name of the contact person, mandatory countryCode: str – ISO2 country code part of the contact address, required if isGpsBased is not True city: str – required if isGpsBased is not True street: str – required if isGpsBased is not True zip: str state: str phone1: str phone2: str mobile: str fax: str mail1: str mail2: str preferredLanguage: str site: str department: str building: str floor: str room: str note: str isGpsBased: bool latitude: float – required if isGpsBased is True longitude: float – required if isGpsBased is True}appointment: { – wrapper object for an initial appointment, must have a valid appointment window if provided interventionType: str – enumeration of the intervention type, mandatory proposedAppointmentStart: fcdatetime – the proposed appointment window start, required if there is no scheduled appointment window defined proposedAppointmentEnd: fcdatetime – the proposed appointment window end, required if there is no scheduled appointment window defined scheduledAppointmentStart: fcdatetime – the scheduled appointment window start, required if there is no proposed appointment window defined scheduledAppointmentEnd: fcdatetime – the scheduled appointment window end, required if there is no proposed appointment window defined comment: str – additional information about the appointment, mandatory resource: str – ID of the assigned engineer}skills: [str] – list of the skills assigned to the ticket, represented by their namesitems: [{ – list of wrapper objects holding item/part information reference: str – a unique reference that represents a single item on the ticket, mandatory name: str – a human readable name of the item, mandatory orderNumber: str orderNumberLineItem: str partNumber: str description: str type: str serial: str manufacturer: str quantity: int status: str – the display text of the item status, deprecated: use statusConstantEnumeration instead statusConstantEnumeration: str – the enumeration of the item status externalStatus: str usage: str replacedSerial: str condition: str failureCode: str customField1: customField1Value – Item custom fields are supported shipping: { – wrapper object for the item shipping information company: str street: str city: str zip: str countryCode: str – ISO2 country code part of the shipping address state: str deliveryType: str eta: fcdatetime shippingDate: fcdatetime receivedDate: fcdatetime shipped: bool trackingCode: str shippingPartner: str shipmentCondition: str deliveryServiceUrl: str comment: str pudo: { – wrapper object for the item shipping Pick-Up/Drop-Off point reference: str – unique reference of a Pick-Up/Drop-Off point, may point to existing PUDO-s name: str countryCode: str – ISO2 country code part of the PUDO address, mandatory city: str street: str streetNumber: str state: str zip: str zipAreaFrom: str zipAreaTo: str openingHrsFrom: fctime openingHrsTo: fctime code: str breaks: str additionalInformation: str logistician: str } }}]
Create Ticket Info
This action creates an info message on the ticket.
ticket: { – wrapper object for ticket/workorder reference information, filling one of the fields is mandatory id: int – the internal identifier of the ticket, not visible on UI cni: int – the short identifier of the ticket, visible on WorkPlace cne: str – external identifier of the ticket internalReference: int – alias for cni reference: str – alias for cne}info: { – wrapper object for the info message message: str – the message to display on the ticket, mandatory}
Create or update Items
This action creates new items or updates existing ones on a ticket based on the provided Item references. Item updates are applied as patches, so values not present on the updated item payload will not be overwritten, but explicit null values will be applied!
ticket: { – wrapper object for ticket/workorder reference information, filling one of the fields is mandatory id: int – the internal identifier of the ticket, not visible on UI cni: int – the short identifier of the ticket, visible on WorkPlace cne: str – external identifier of the ticket internalReference: int – alias for cni reference: str – alias for cne}items: [{ – list of wrapper objects holding item/part information reference: str – a unique reference of a new or existing item on the ticket mandatory name: str – a human readable name of the item orderNumber: str orderNumberLineItem: str partNumber: str description: str type: str serial: str manufacturer: str quantity: int status: str – the display text of the item status deprecated: use statusConstantEnumeration instead statusConstantEnumeration: str – the enumeration of the item status externalStatus: str usage: str replacedSerial: str condition: str failureCode: str customField1: customField1Value – Item custom fields are supported shipping: { – wrapper object for the item shipping information company: str street: str city: str zip: str countryCode: str – ISO2 country code part of the shipping address state: str deliveryType: str eta: fcdatetime shippingDate: fcdatetime receivedDate: fcdatetime shipped: bool trackingCode: str shippingPartner: str shipmentCondition: str deliveryServiceUrl: str comment: str pudo: { – wrapper object for the item shipping Pick-Up/Drop-Off point reference: str – unique reference of a Pick-Up/Drop-Off point may point to existing PUDO-s name: str countryCode: str – ISO2 country code part of the PUDO address mandatory city: str street: str streetNumber: str state: str zip: str zipAreaFrom: str zipAreaTo: str openingHrsFrom: fctime openingHrsTo: fctime code: str breaks: str additionalInformation: str logistician: str } }}]
Save Document
This action uploads a Base64 format document to a ticket as attachment.
ticket: { – wrapper object for ticket/workorder reference information, filling one of the fields is mandatory id: int – the internal identifier of the ticket, not visible on UI cni: int – the short identifier of the ticket, visible on WorkPlace cne: str – external identifier of the ticket internalReference: int – alias for cni reference: str – alias for cne}document: { – wrapper object for the attachment document filename: str – the filename including extension, mandatory content: str – the base64 encoded file content, mandatory}
Submit Interface Form
This action calls an Interface Form by its Form ID and the ID of the Object to modify with the provided values. To start using this action, you must first setup an Interface Form in the ‘Fieldcode Plus > Forms’ admin panel page. Once you have saved your Interface Form you can download and view the expected payload model in the Form editor, using the “Download payload” button at the bottom of the left side panel.
For this action we recommend pasting the parameters straight from the downloaded payload model!
formId: str – the ID of the Interface Form to submit, mandatoryentityType: str – the type of the target object, mandatoryentityId: str – the ID of the target object, mandatoryparams: {} – key-value pairs of the form parameters, mandatoryvalues: {} – key-value pairs of the updated values, mandatory
Save Absence (deprecated)
This action creates an absence for an existing resource.
resource: str – ID of the resource, mandatorytype: str – enumeration of the absence type, mandatoryto: fcdatetime – start of the absence window, mandatoryfrom: fcdatetime – end of the absence window, mandatoryexternalId: str – external ID of the resourceactive: boolreason: strsubstitute: str
Update Absence (deprecated)
This action updates an existing absence for an existing resource.
absenceId: str – ID of the absence to update, mandatoryresource: str – ID of the resource, mandatorytype: str – enumeration of the absence type, mandatoryto: fcdatetime – start of the absence window, mandatoryfrom: fcdatetime – end of the absence window, mandatoryexternalId: str – external ID of the resourceactive: booldeactivationReason: str – reason for deactivation, mandatory if active is Falsereason: strsubstitute: str