Operation - com.hornbill.servicemanager::Requests/logRequest


General Description

This operation creates a new Request using the supplied information.

Request Message

Input Parameters

The Requests/logRequest 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 This parameter can be set with the Request's summary.
description xs:string optional This parameter can be set with the Request's description.
requestType xs:string required once This parameter must be set with the Request's type. The options are Incident, Service Request, Problem, Known Error, Change Request or Release.
customerId xs:string optional This parameter can be set with the Id of the Request's customer. When the customer is a Co-worker, supply their User Id. When the customer is a Contact, supply their record Id (value in h_pk_id of h_sys_contacts table).
customerType xs:int optional This parameter can be set with the type of Request's customer. When the customer is a Co-worker, supply 0. When the customer is a Contact, supply 1. This option should only be supplied when 'customerId' parameter is set.
ownerId xs:string optional This parameter can be set with the Id of the Request's owner. When the customer is a Co-worker, supply their User Id. When the customer is a Contact, supply their record Id (value in h_pk_id of h_sys_contacts table).
teamId xs:string optional This parameter can be set with the Id of the Request's team.
status xs:string optional This parameter can be set with the Request's status. The options are status.new, status.open, status.onHold, status.resolved, status.closed, status.cancelled or status.reopened.
priorityId xs:string optional This parameter can be set with the Id of the Request's priority. Refer to the value in h_pk_priorityid of h_itsm_priority table for the Id of a priority.
categoryId xs:string optional This parameter can be set with the Id of the Request's category.
categoryName xs:string optional This parameter can be set with the display name of the Request's category. This option should only be supplied when 'categoryId' parameter is set.
image xs:string optional This parameter can be set with the path of an image. This option is only applicable to Requests that are raised from an email.
sourceType xs:string optional This parameter can be set with the type of the Request's source. The options are Email, Autoresponder, Analyst, Request, Self Service, Guest Access or Chat.
sourceId xs:string optional This parameter can be set with the Id of the Request's source. For example, when 'sourceType' parameter is set to Analyst, this option should be set with the Id of the Co-worker who is raising the Request. This option should only be supplied when 'sourceId' parameter is set.
impact xs:string optional THIS PARAMETER IS NOW DEPRECATED.
urgencyId xs:string optional The ID of the request's urgency level
urgency xs:string optional THIS PARAMETER IS NOW DEPRECATED.
serviceId xs:string optional This parameter can be set with the Id of the Request's service. Please note that the Request's BPM will not be spawned by this operation. You may use logRequestBPM operation or alternatively, create a Request using the log operation under each Request type (E.g. For Incidents, use Incidents::fc_ops::logIncident operation).
questions xs:string optional This parameter is set with the Progressive Capture data for the Request. This is supplied as a JSON Object in form of a String.
resolutionDetails xs:string optional This parameter can be set with the resolution text that will be used when resolving the Request.
siteId xs:int optional This parameter can be set with the Id of the site that is associated to the Request.
siteName xs:string optional This parameter can be set with the name of the site that is associated to the Request. This option should only be supplied if 'siteId' parameter is set.
catalogId xs:string optional This parameter can be set with the Id of the Request's catalog. This option should only be supplied if 'serviceId' parameter is set.
catalogName xs:string optional This parameter can be set with the name of the Request's catalog. This option should only be supplied if 'catalogId' and 'serviceId' parameters are set.
externalRefNumber xs:string optional This parameter can be set with the Request's external reference number.
questionFieldMap xs:string optional This parameter can be set with the data for mapping Progressive Capture answers to Request fields. This is supplied as a JSON Object in form of a String.
senderDetails xs:string optional This parameter can be set with the details of the email sender when a Request is raised via the Autoresponder.
ccDetails xs:string optional This parameter can be set with the details of the email cc recipient when a Request is raised via the Autoresponder.

Response Message

Output Parameters

The Requests/logRequest method returns the following output parameters.

Name Type Attributes Description
requestId xs:string optional This parameter is set with the Id of the Request created.
bpmProcessId xs:string optional This parameter is set with the Id of the Request's BPM instance.
exceptionName xs:string optional This parameter is set with any validation errors.
exceptionDescription xs:string optional THIS PARAMETER IS NOW DEPRECATED.
summary xs:string optional This parameter is set with the summary of the Request created.
Powered by Hornbill, for more information click here. (page served by .)