Operation - com.hornbill.servicemanager::ServiceRequests/logServiceRequest


General Description

This flowcode operation logs a Service Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the service request before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.

Request Message

Input Parameters

The ServiceRequests/logServiceRequest method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
summary xs:string optional The service request summary.
description xs:string optional The service request description.
requestType xs:string optional The type of request (Service Request)
customerId xs:string optional The customer Id (Co-worker / Contact). If the customer is a co-worker, the id will be their login name. If the customer is a contact, the id will be the h_pk_id value of their record in the h_sys_contact table.
customerType xs:string optional The customer type (Co-worker / Contact). 0 for a co-worker, 1 for a contact.
ownerId xs:string optional The co-worker Id of the owner of the service request.
teamId xs:string optional The Id of the team assigned to the Request. This is the h_id value of the record in the h_sys_groups table for the assigned team.
status xs:string optional The status of the service request. Examples are status.new, status.open, status.resolved. When not supplied, the value "status.new" is considered.
priorityId xs:string optional The Id of the chosen priority for the service request. By default, High (1), Medium (2), Low (3).
categoryId xs:string optional The Id of the chosen category for the service request.
categoryName xs:string optional The Name of the category
image xs:string optional WebDAV path to an image (from email only).
sourceType xs:string optional The source from where the service request was raised (e.g. Email / Post).
sourceId xs:string optional The Id if the source object it was raised from (if Email:messageId, if Post:ActivityStreamID and ActivityID).
assetId xs:string optional
minOccurs=0
maxOccurs=unbounded
The Id(s) of all assets to be associated to the service request.
impact xs:string optional The impact of the service request. E.g. High, Medium, Low.
urgencyId xs:string optional The ID of the request's Urgency level
serviceId xs:string optional The id of the selected service. This will be used to spawn a bpm process.
questions xs:string optional Questions that were answered during progressive capture
resolutionDetails xs:string optional The resolution details if the service request is to be raised and resolved at the same time.
fileName xs:string optional
minOccurs=0
maxOccurs=unbounded
The full path for the file(s) to be attached
siteId xs:string optional ID of the site this request is affecting
siteName xs:string optional Name of the site this request is affecting
catalogId xs:string optional The Catalog Id the Request was raised against
catalogName xs:string optional The Catalog Name the Request was raised against
externalRefNumber xs:string optional This parameter is to be set with the External Reference Number of a Request.
bpmName xs:string optional The custom BPM Name when raising a request via a customised Service Catalog
questionFieldMap xs:string optional Question Field Map as JSON
senderDetails xs:string optional JSON string containing email sender details if the request is being raised via the autoresponder.
ccDetails xs:string optional JSON string containing email cc receipient details if the request is being raised via the autoresponder.
connectionMap xs:string optional Connection Map as JSON
connectionUpdateTimeline xs:boolean optional Update timeline true/false
connectionTimelineVisibility xs:string optional Visibility level of timeline updates for added connections. Timeline update visibility defaults to Team if not provided.

Response Message

Output Parameters

The ServiceRequests/logServiceRequest method returns the following output parameters.

Name Type Attributes Description
requestId xs:string optional The Id of the new service request.
bpmProcessId xs:string optional The Id of the spawned Bpm process for the new service request.
exceptionName xs:string optional The name / code of any exception thrown during the creation of the service request.
exceptionDescription xs:string optional A description of any exception thrown during the creation of the service request.
summary xs:string optional The provided summary of the service request.
warnings xs:string optional Any warnings that were encountered when logging the service request.
Powered by Hornbill, for more information click here. (page served by .)