WorkOrders

Create a Work order

Creates a new Work order. Returns Work order Id for successful request. <br />Available for provider and subscriber usage. <br />Additional info: <br />Updates GL code based on passed Category param according to settings in Admin module {go to Admin => Accounting => GlCodes to see user GL codes}. Similar logic is used when you create Work order through next path: Dashboard => Request Service.

post/workorders

Request

Request body

Numberstring

Work Order Number

PurchaseNumberstring

Purchase Order Number

HasTruncatedDescriptionboolean

Optional

Commentstring

Optional, Gets or sets the comment. Describes comments in work order

SetupIdinteger

Optional Dashboard Id, UID of dashboard from which this work order was created must be bigger then zero and belong to existing dashboard

AssetIdinteger

Optional Asset, UID of asset, that will be repaired/reinstalled must be present and correspond to valid asset if system finds that asset exists for specified LocationId, TradeName, IssueRequest.EquipmentType params and asset is required for issue choice specified by IssueRequest, SubscriberId and SetupId params

ReplaceAssetboolean

Optional

CallerNamestring

Optional, can be empty Caller Name. Name of the person/organization who created work order

Categorystring required

Required, not empty Category must be valid category for specified subscriber. Describes what type of work will be performed. This definition is broader then TradeName. For example if TradeName is "FLOOR MAINTENANCE" then Category will be "Maintenance"

CategoryIdinteger
Prioritystring

Required, not empty Priority must be valid priority for specified subscriber. Describes work order priority. For example "Normal", "Emergency"

PriorityIdinteger
Ntenumber double

Required Nte value; optional only for users that have no access to change NTE. (decimal number (e.g. 1.00)) - describes maximum amount of money to be spent on work order. Must not exceed max amount defined by Subscriber. If you specify ExtendedInfo.Tax, ExtendedInfo.Tax2 and ExtendedInfo.Price then Nte must be equal to sum of those three params

CallDatestring required

Required, date when work order was created.

CallDateDtostring date-time

Date when work order was created in DateTimeOffset format.

ScheduledDatestring

Optional, calculated based on CallDate and Priority by default. Date when provider will come to perform work order. Must be an actual date (i.e. not 1/1/1900 or 1/1/3001) + must be bigger then CallDate and smaller then ExpirationDate

ScheduledDateDtostring date-time

Date when provider will come to perform work order in DateTimeOffset format.

CompletedDatestring

Optional, WorkDate when its not completed status.

ProblemSourcestring

Optional, source from which the problem came from

Descriptionstring required

Required problem description, Must not be empty. Overall description of a problem (e.g. "Coffee machines are broken all over the place - please help!")

ProblemCodestring required

Required, describes problem similar to Description attribute, but its value is predefined in subscriber's [IssueList].

RecallWorkOrderinteger

Optional, UID of recalled work order. Work order is set as 'recalled' when subscriber isn't satisfied with work that was done by provider

ServiceNowIdstring

Optional, Service Now Id

CurrencyIdinteger

Optional, UID of currency used to pay for work order. Defaul value is '1' which corresponds to USD. Must be bigger then 0 and correspond to valid currency in dashboard which is found by SetupId param

FollowupWorkOrderinteger

Optional, UID of work order that is created if problem cannot be fully solved in terms of original work order

ApprovalCodestring

Optional

IgnoreAttachmentsRequiredFlagboolean
ApiRequestboolean
IssueListHeaderIdinteger

Optional. Id in dash_IssueListHeader table

ProposedNtenumber double

Optional

NotifyProviderboolean

Optional

IsDashboardRequestboolean

Optional

FloorPlansImagePathstring

Optional

AssigneeUserIdinteger

Optional

SessionIdstring

SessionId to link work order with feedback session

ProjectIdinteger

Optional. Project Id from Project Tracker

WeatherTypeIdinteger

Optional. Associate with a specific weather type

LabelIdinteger

Optional, Label Id

Labelsstring[]

Optional, Labels names

AdditionalApprovalCodesListobject

Additional Approval Codes List with id as a key

LeaseNotestring
UserNamestring
UserIdinteger
WorkFlowTypeIdinteger
EstimatedCompletionDatestring date-time
IsAnomalyProviderOverwrittenboolean

Flag to show that Anomaly Override has happened.

AssetNotListedboolean
SpaceIdinteger
LocationPathstring

Response

Created indicates that the request resulted in a new resource created before the response was sent.

Changes

No recorded changes to this operation across all 1 revision of this API.