Cityworks Developer Guide

Introduction

This guide is intended to provide app developers with general guidance on how to effectively access relevant work information within the Cityworks system.  Each asset team in DDOT interacts with Cityworks in a different way and some of the below may not apply to specific asset teams.  To get a full understanding of the Cityworks asset management system, we first recommend reading the introductory documentation.  This will provide a good background of the overall purpose of the system.

Cityworks API Guidance

API Documentation

Cityworks has a robust API and the full documentation for that library can be found there.

Search Work Orders or Service Requests by Type/Status (SEARCH)

To start, a DDOT asset management contractor generally will have access to one or more work order types in Cityworks.  After meeting with DDOT's IT team and relevant asset management team(s), you will be provided with one or more template IDs - these are the unique identifiers corresponding to the work order or service request types you are responsible for.

Using the Search method, you can provide these template IDs and/or other filtering attributes (such as status) to get a list of Work Order or Service Request IDs. 

• Work Orders:  https://cw.ddot.dc.gov/Cityworks/services/Ams/WorkOrder/Search (docs)
• Service Requests:  https://cw.ddot.dc.gov/Cityworks/services/Ams/ServiceRequest/Search (docs)

After you have queried the system for a listing of IDs, the next step (usually) is to iterate through this list and do one of two things:

1. Get more info on a Work Order/Service Request
2. Perform an update on a Work Order/Service Request

Get more info on a Work Order or Service Request (ByID/ByIDs)

After you have a Work Order or Service Request ID, you can pass that ID to the appropriate method below to get the full detail:

• Work Orders:  (docs) 
  • For a single Work Order:  https://cw.ddot.dc.gov/Cityworks/services/Ams/WorkOrder/ById
  • For a list of Work Orders:  https://cw.ddot.dc.gov/Cityworks/services/Ams/WorkOrder/ByIds
• Service Requests:   (docs)
  • For a single Service Request:  https://cw.ddot.dc.gov/Cityworks/services/Ams/ServiceRequest/ById
  • For a list of Service Requests:  https://cw.ddot.dc.gov/Cityworks/services/Ams/ServiceRequest/ByIds

Perform an update on a Work Order or Service Request (UPDATE)

After you have a Work Order or Service Request ID, you may then update relevant fields (such as status)

• Work Orders:  (docs) 
  • https://cw.ddot.dc.gov/Cityworks/services/Ams/WorkOrder/Update
• Service Requests:   (docs)
  • https://cw.ddot.dc.gov/Cityworks/services/Ams/ServiceRequest/Update

Find Service Requests linked to a Work Order

A work order will usually have at least one service request (what comes from 311) associated/linked to it.  The below method retrieves the ones associated to a specific work order.  

• https://cw.ddot.dc.gov/Cityworks/services/Ams/WorkOrder/WorkOrderServiceRequests