Citywide Service Request Connector

Description

This transformer handles the creation of Service Requests with the Citywide REST API. It can be used to access various POST actions, including create new Service Requests and attaching Notes, Files, and Attributes.

Usage

To use this transformer, a JSON POST body must be assembled to be sent to the relevant endpoint. It preforms one function at a time, which can be selected under Basic Parameters. Several uses of this transformer must be chained together to accomplish the entire Service Request creation process.

Basic Parameters

Select a Function - Select which REST API action to preform.

Create New Service Request: creates a new Citywide Service Request.

Commit Service Request Transaction: this step must be preformed in order for the new Service Request to be available in the Citywide Web UI or Citwide Mobile App.

Add Note to Service Request: Attaches a note to a pre-existing Service Request.

Add File to Service Request: Attaches a file to a pre-existing Service Request.

Add Attribute to Service Request: Attaches an attribute to a pre-existing Service Request. Attributes may be required before the Commit step.

Web Connection - A valid Citywide web authentication connection.

Values

Post Body - This is required for creating new Service Requests, adding notes and adding attributes. The post body should be in valid JSON format. For more information regarding the required fields for each endpoint, please refer to the Citywide API documentation. Note that this field can be left blank when attaching files.

Transaction ID - This is required to commit newly created Service Request. This ID will be provided as output when creating a new Service Request as cw_transaction_id.

Location - This is required for attaching notes, files, and attributes to a Service Request. This will be provided as output when creating a new Service Request as cw_sr_location. The location should should consist of the Citywide Service Request endpoint with the relevant Service Request ID at the end.

File - File location, required when attaching files.

File Description - Required when attaching files.