Class Request

Hierarchy

Request

Index

Methods - Request Search

Methods - Request Templates

createTemplateSearchDefinition getTemplateQAs getTemplates getTemplatesById getWOTemplates searchTemplates

Methods - Requests

cancel changeCustomFieldCategory changeProblem close create createSearchDefinition delete deleteMLFs getAuditLog getById getByIds getCustomFields getMLFs move reopen uncancel update updateMLF updateMLFs

Properties

`Optional` admin

admin?: any

Request Administration methods

attachments

attachments: any

Attachments methods

comment

comment: any

Request Comments methods

costs

costs: any

Request Costing methods

Request Categorization Methods

getProblemNodes

getProblemNodes(domainId: number, viewOnly?: boolean, displayMode?: Object, includeCancelled?: boolean): Promise<unknown>
Get a list of problem nodes for a domain

Returns
Returns Promise that represents a collection of problem node objects.
Parameters
- domainId: number
  
  The domain ID for which to retrieve problem nodes.
- viewOnly: boolean = false
  
  Return only view only problem nodes. Defaults to false.
- Optional displayMode: Object
  
  Object that should contain two properties if you provide it: DisplayTextMode: string (C = Code, D = Description, CD = Code ~ Description). DisplayTextDelimeter: string, only impacts CD display text mode.
- includeCancelled: boolean = false
  
  Return only cancelled problem nodes as well. Defaults to false.
Returns Promise<unknown>
- Defined in request.ts:448

Request Object Search Methods

searchObject

searchObject(requestId: string): Promise<unknown>
Get the records on the basis of RequestId, only populates RequestId, Description, ProblemCode properties

Returns
Returns Promise that represents a collection of the matching (limited) request objects
Parameters
- requestId: string
  
  ???, see instance docs: /{subdirectory}/apidocs/#/service-info/Ams/ServiceRequest
Returns Promise<unknown>
- Defined in request.ts:396

Request Options Methods

getCustomFieldTemplate

getCustomFieldTemplate(problemSid: number): Promise<unknown>
Get custom field templates for problem code

Returns
Returns Promise that represents a collection of custom fields
Parameters
- problemSid: number
  
  The problemSid whose template custom fields should be returned
Returns Promise<unknown>
- Defined in request.ts:543

getDispatchTos

getDispatchTos(domainId: number): Promise<unknown>
Get a list of possible DispatchTo values

Returns
Returns Promise that represents an Array of dispatchTo options.
Parameters
- domainId: number
  
  Domain to return possible dispatchTo values for
Returns Promise<unknown>
- Defined in request.ts:649

getEmployeeLists

getEmployeeLists(listType: string, domainId: number): Promise<unknown>
Get a list of possible Employee values

Returns
Returns Promise that represents an Array of Employee options.
Parameters
- listType: string
  
  Which list (endpoint) to get. Includes only DispatchTo & SubmitTo.
- domainId: number
  
  Domain to return possible dispatchTo values for
Returns Promise<unknown>
- Defined in request.ts:624

getPriorities

getPriorities(problemSid: number): Promise<unknown>
Get a list of a problem code's priorities

Returns
Returns Promise that represents an Array of priorities
Parameters
- problemSid: number
  
  Return priorities for given problemSid
Returns Promise<unknown>
- Defined in request.ts:523

getProblemLeaf

getProblemLeaf(problemSid: number): Promise<unknown>
Get problem leaf (template) by Sid

Returns
Returns Promise that represents an Object that describes the problem leaf (template)
Parameters
- problemSid: number
  
  Return problem leaf for given problemSid
Returns Promise<unknown>
- Defined in request.ts:583

getProblems

getProblems(forPublicOnly?: boolean, onlyActiveTemplates?: boolean, domainIds?: number[]): Promise<unknown>
Get a list of problem codes

Returns
Returns Promise that represents an Array of problem name objects.
Parameters
- forPublicOnly: boolean = false
  
  Return only publicly-available service requests. Defaults to false.
- onlyActiveTemplates: boolean = true
  
  Return only active templates. Defaults to true.
- Optional domainIds: number[]
Returns Promise<unknown>
- Defined in request.ts:479

getProblemsByKeywords

getProblemsByKeywords(keywords: string): Promise<unknown>
Get a list of problem codes by keywords

Returns
Returns Promise that represents an Array of problem name objects.
Parameters
- keywords: string
  
  Keywords to search for potential problem codes
Returns Promise<unknown>
- Defined in request.ts:503

getQASettings

getQASettings(problemSid: number): Promise<unknown>
Get the questions and answer options for a problem code

Returns
Returns Promise that represents a collection of questions and answer settings
Parameters
- problemSid: number
  
  The problemSid whose Q&A should be returned
Returns Promise<unknown>
- Defined in request.ts:563

getStatuses

getStatuses(domainIds: number[]): Promise<unknown>
Get a list of default statuses

Returns
Returns Promise that represents an Array of statuses.
Parameters
- domainIds: number[]
  
  List of domains to return default statuses for
Returns Promise<unknown>
- Defined in request.ts:603

getSubmitTos

getSubmitTos(domainId: number): Promise<unknown>
Get a list of possible SubmitTo values

Returns
Returns Promise that represents an Array of submitTo options.
Parameters
- domainId: number
  
  Domain to return possible submitTo values for
Returns Promise<unknown>
- Defined in request.ts:661

streetCodes

streetCodes(): Promise<unknown>
Get street codes

Returns
Returns Promise that represents an Array of Street Codes.

Returns Promise<unknown>
- Defined in request.ts:672

Request Search Methods

search

search(searchData: Object): Promise<unknown>
Search for requests

Returns
Returns Promise that represents an Array of the matching request IDs
Parameters
- searchData: Object
  
  The search information to retrieve matched requests, see instance docs: /{subdirectory}/apidocs/#/service-info/Ams/ServiceRequest
Returns Promise<unknown>
- Defined in request.ts:378

Request Templates Methods

createTemplateSearchDefinition

createTemplateSearchDefinition(searchData: Object, searchName?: string, sharedWithin?: number, saveDefinition?: boolean): Promise<unknown>
Create a search definition. Save the definition by setting SaveDefinition = true and supplying a SearchName.

Returns
Returns Promise that represents a collection of Cityworks Metadata Objects. See: /{subdirectory}/apidocs/#/data-type-info;dataType=CWMetadata
Parameters
- searchData: Object
  
  Search data variables. See /{subdirectory}/apidocs/#/service-info/Ams/ServiceRequestTemplate
- Optional searchName: string
  
  What to name your search (if it should be saved)
- Optional sharedWithin: number
  
  What group or domain to share the search to.
- saveDefinition: boolean = true
  
  Whether or not to save the search definition. Defaults to true when a search name is specified.
Returns Promise<unknown>
- Defined in request.ts:721

getTemplateQAs

getTemplateQAs(problemSids: number[], minimumDateModified?: Date, maximumDateModified?: Date): Promise<unknown>
Get the questions and answers for a(many) request template(s)

Returns
Returns Promise that represents a collection of ProblemQAs. See /{subdirectory}/apidocs/#/data-type-info;dataType=ProblemQA
Parameters
- problemSids: number[]
  
  An array list of problemSids to retrieve templates for
- Optional minimumDateModified: Date
- Optional maximumDateModified: Date
Returns Promise<unknown>
- Defined in request.ts:745

getTemplates

getTemplates(templateIds?: number[], canCreate?: boolean, includeInactiveIf?: boolean, minimumDateModified?: Date, maximumDateModified?: Date): Promise<unknown>
Get request templates (problem leaf[s])

Returns
Returns Promise that represents a collection of Problem Leafs. See /{subdirectory}/apidocs/#/data-type-info;dataType=ProblemLeaf
Parameters
- Optional templateIds: number[]
  
  Array of specific template IDs to retrieve
- canCreate: boolean = false
  
  If true, only return templates the user can create, ignored if false or null, default is false
- includeInactiveIf: boolean = false
  
  If true, returns inactive templates, default is false
- Optional minimumDateModified: Date
  
  ?
- Optional maximumDateModified: Date
  
  ?
Returns Promise<unknown>
- Defined in request.ts:787

getTemplatesById

getTemplatesById(problemSids: number[], minimumDateModified?: Date, maximumDateModified?: Date): Promise<unknown>
Get a list of templates

Returns
Returns Promise that represents
Parameters
- problemSids: number[]
  
  An array list of problemSids to retrieve templates for
- Optional minimumDateModified: Date
  
  ?
- Optional maximumDateModified: Date
  
  ?
Returns Promise<unknown>
- Defined in request.ts:691

getWOTemplates

getWOTemplates(problemSids: number[], includeInactive?: boolean): Promise<unknown>
Get WorkOrder templates that are associated to this request template type

Returns
Returns Promise that represents a collection of Problem WO Templates. See /{subdirectory}/apidocs/#/data-type-info;dataType=ProblemWOTemplate
Parameters
- problemSids: number[]
  
  An array list of problemSids to retrieve Problem WO templates for
- includeInactive: boolean = false
Returns Promise<unknown>
- Defined in request.ts:818

searchTemplates

searchTemplates(searchData: Object): Promise<unknown>
Get a list of template id results for a provided search parameters

Returns
Returns Promise that represents a list of template IDs.
Parameters
- searchData: Object
  
  Search data variables. See /{subdirectory}/apidocs/#/service-info/Ams/ServiceRequestTemplate
Returns Promise<unknown>
- Defined in request.ts:765

Requests Methods

cancel

cancel(requestIds: number[], cancelReason?: string, dateCancelled?: Date): Promise<unknown>
Cancel requests

Returns
Returns object that represents a collection of requests
Parameters
- requestIds: number[]
  
  An array of the IDs to cancel the matched requests
- Optional cancelReason: string
  
  A reason for cancelling the request(s)
- Optional dateCancelled: Date
  
  The date/time that it should be indicated the request was cancelled
Returns Promise<unknown>
- Defined in request.ts:267

changeCustomFieldCategory

changeCustomFieldCategory(requestIds: number[], categoryId: number): Promise<unknown>
Change custom field category for provided requests

Returns
Returns Promise that represents a collection of requests
Parameters
- requestIds: number[]
  
  The RequestIds whose custom fields should be returned
- categoryId: number
  
  The new custom field grouping/category which should be assigned to the provided requests
Returns Promise<unknown>
- Defined in request.ts:244

changeProblem

changeProblem(requestId: number, problemSid: number): Promise<unknown>
Change a request's problem code

Returns
Returns Promise that represents an object describing the updated request
Parameters
- requestId: number
  
  The request ID to change
- problemSid: number
  
  The request's new ProblemSID
Returns Promise<unknown>
- Defined in request.ts:144

close

close(requestIds: number[]): Promise<unknown>
Close requests

Returns
Returns object that represents a collection of requests
Parameters
- requestIds: number[]
  
  An array of the IDs to close the matched requests
Returns Promise<unknown>
- Defined in request.ts:310

create

create(sr_data: Object): Promise<unknown>
Create new requests

Returns
Returns Promise that represents an object describing the newly-created request
Parameters
- sr_data: Object
  
  See /{subdirectory}/apidocs/#/data-type-infodataType=RequestBase on the Cityworks instance
Returns Promise<unknown>
- Defined in request.ts:47

createSearchDefinition

createSearchDefinition(searchData: Object, searchName?: string, sharedWithin?: number, saveDefinition?: boolean, enableEurl?: boolean): Promise<unknown>
Create a search definition. Save the definition by setting SaveDefinition = true and supplying a SearchName.

Returns
Returns Promise that represents a collection of Cityworks Metadata Objects
Parameters
- searchData: Object
  
  Search data variables. See /{subdirectory}/apidocs/#/service-info/Ams/ServiceRequest
- Optional searchName: string
  
  What to name your search (if it should be saved)
- Optional sharedWithin: number
  
  What group or domain to share the search to.
- saveDefinition: boolean = true
  
  Whether or not to save the search definition. Defaults to true when a search name is specified.
- enableEurl: boolean = true
  
  Whether or not to enable EURL for the saved search. Defaults to true.
Returns Promise<unknown>
- Defined in request.ts:420

delete

delete(requestIds: number[]): Promise<unknown>
Delete requests

Returns
Returns object that represents a collection of request Ids which have been deleted
Parameters
- requestIds: number[]
  
  An array of the IDs to delete the matched requests
Returns Promise<unknown>
- Defined in request.ts:354

deleteMLFs

deleteMLFs(requestId: number): Promise<unknown>
Delete Map Layer Fields

Returns
Returns Promise that represents a collection of Objects describing the deleted map layer fields
Parameters
- requestId: number
  
  The request ID to delete the map layer fields for.
Returns Promise<unknown>
- Defined in request.ts:896

getAuditLog

getAuditLog(requestId: number): Promise<unknown>
Get the audit log for a specific request

Returns
Returns Promise that represents a collection of Cityworks Metadata Objects
Parameters
- requestId: number
  
  A Request ID to get the audit log for
Returns Promise<unknown>
- Defined in request.ts:205

getById

getById(requestId: number): Promise<unknown>
Get a request by ID

Returns
Returns Promise that represents an object describing the request
Parameters
- requestId: number
  
  The ID of the request to retrieve
Returns Promise<unknown>
- Defined in request.ts:165

getByIds

getByIds(requestIds: number[]): Promise<unknown>
Get requests by array of IDs

Returns
Returns Promise that represents a collection of Objects describing the requests
Parameters
- requestIds: number[]
  
  The request IDs to retrieve
Returns Promise<unknown>
- Defined in request.ts:185

getCustomFields

getCustomFields(requestIds: number[]): Promise<unknown>
Get custom fields for provided requests

Returns
Returns Promise that represents a collection of custom fields
Parameters
- requestIds: number[]
  
  The RequestIds whose custom fields should be returned
Returns Promise<unknown>
- Defined in request.ts:223

getMLFs

getMLFs(requestId: number): Promise<unknown>
Get Map Layer Fields

Returns
Returns Promise that represents a collection of Objects describing the request map layer fields
Parameters
- requestId: number
  
  The request ID to get the map layer fields for.
Returns Promise<unknown>
- Defined in request.ts:839

move

move(requestId: number, x: number, y: number, projection: {
    VcsWKID?: string;
    WKID?: string;
    WKT?: string;
}, z?: number): Promise<unknown>
Move a request's point

Returns
Returns Promise that represents an object describing the updated GISPoint
Parameters
- requestId: number
- x: number
- y: number
- projection: {
      VcsWKID?: string;
      WKID?: string;
      WKT?: string;
  }
  
  Should include at least WKT or WKID attribute. Can also include VcsWKID attribute.
  - Optional VcsWKID?: string
  - Optional WKID?: string
  - Optional WKT?: string
- Optional z: number
  
  Optional Z coordinate
Returns Promise<unknown>
- Defined in request.ts:93

reopen

reopen(requestIds: number[]): Promise<unknown>
Reopen closed requests

Returns
Returns object that represents a collection of requests
Parameters
- requestIds: number[]
  
  An array of the IDs to reopen the matched requests
Returns Promise<unknown>
- Defined in request.ts:334

uncancel

uncancel(requestIds: number[]): Promise<unknown>
Uncancel requests

Returns
Returns object that represents a collection of requests
Parameters
- requestIds: number[]
  
  An array of the IDs to uncancel the matched requests
Returns Promise<unknown>
- Defined in request.ts:290

update

update(sr_data: Object): Promise<unknown>
Update a request

Returns
Returns Promise that represents an object describing the updated request
Parameters
- sr_data: Object
  
  See /{subdirectory}/apidocs/#/data-type-infodataType=RequestBase on the Cityworks instance
Returns Promise<unknown>
- Defined in request.ts:68

updateMLF

updateMLF(requestId: number): Promise<unknown>
Update request's map layer fields

Returns
Returns Promise that represents an object describing the updated map layer fields
Parameters
- requestId: number
Returns Promise<unknown>
- Defined in request.ts:123

updateMLFs

updateMLFs(requestId: number, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>
Update Map Layer Fields

Returns
Returns Promise that represents a ...
Parameters
- requestId: number
  
  The service request ID to get the map layer fields for.
- Optional x: number
- Optional y: number
- Optional domainId: number
  
  Domain ID
- Optional z: number
  
  Optional Z coordinate
Returns Promise<unknown>
- Defined in request.ts:864

Class Request

Hierarchy

Index

Properties

Methods - Request Categorization

Methods - Request Object Search

Methods - Request Options

Methods - Request Search

Methods - Request Templates

Methods - Requests

Properties

Optional admin

attachments

comment

costs

Request Categorization Methods

getProblemNodes

Returns

Parameters

domainId: number

viewOnly: boolean = false

Optional displayMode: Object

includeCancelled: boolean = false

Returns Promise<unknown>

Request Object Search Methods

searchObject

Returns

Parameters

requestId: string

Returns Promise<unknown>

Request Options Methods

getCustomFieldTemplate

Returns

Parameters

problemSid: number

Returns Promise<unknown>

getDispatchTos

Returns

Parameters

domainId: number

Returns Promise<unknown>

getEmployeeLists

Returns

Parameters

listType: string

domainId: number

Returns Promise<unknown>

getPriorities

Returns

Parameters

problemSid: number

Returns Promise<unknown>

getProblemLeaf

Returns

Parameters

problemSid: number

Returns Promise<unknown>

getProblems

Returns

Parameters

forPublicOnly: boolean = false

onlyActiveTemplates: boolean = true

Optional domainIds: number[]

Returns Promise<unknown>

getProblemsByKeywords

Returns

Parameters

keywords: string

Returns Promise<unknown>

getQASettings

Returns

Parameters

problemSid: number

Returns Promise<unknown>

getStatuses

Returns

Parameters

domainIds: number[]

Returns Promise<unknown>

getSubmitTos

`Optional` admin

`Optional` displayMode: Object

`Optional` domainIds: number[]

`Optional` searchName: string

`Optional` sharedWithin: number

`Optional` minimumDateModified: Date

`Optional` maximumDateModified: Date

`Optional` templateIds: number[]

`Optional` minimumDateModified: Date

`Optional` maximumDateModified: Date

`Optional` minimumDateModified: Date

`Optional` maximumDateModified: Date

`Optional` cancelReason: string

`Optional` dateCancelled: Date