Skip to content

Configure web services

Actions define how incoming message(s) are handled

Field Description
Integration Reference to the Integration record
Display Name The friendly name for this web service
Name The name that is used in the URL that points to this web service
Version The version that this web service carries

Mapping Configuration

Field Description
Action
  • Create
    This option will make the web service create new records
  • Create and Update
    This option will make the web service be able to create and update records
  • Update
    This option will make the web service be able to only update existing records
  • Provide Data
    This option will make the web service return records
  • Delete
    This option will make the web service delete existing records
Table The table that will be used for actions on this web service
Use Advanced Record Lookup When checked, an encoded query can be used instead of the condition builder
Advanced Record Lookup The condition that will be used to find records if "Use Advanced Record Lookup" is checked
Record Lookup The condition that will be used to find records
Remove Parameter Condition If Not Passed Only applicable when using {url.parameter} in the condition. If checked and no parameter is passed to the web service, the condition will be removed from the record lookup
Order By Only applicable for when "Provide Data" is selected. Select the field that is used to order the records
Order By Descending Only applicable for when "Provide Data" is selected. When checked the returend records will be ordered descending

Response

Field Description
Response Headers Specific headers that will be returned to the client. The value can contain variables in the form of ${variable}
Response Template The JSON message that will be returned to the client. In case of multiple records (depending on the settings) for action "Provide Data" this template will be used per record and the result will be an array
Always Return Array Only applicable for action "Provide Data". The result will always be an array even if only one record is found

Custom Responses

Field Description
Enable Custom Responses When checked the default responses can be overwritten. If the template is left empty the default will be used.
Bad Request Template (400) Template for a Bad Request (400) response
User Not Allowed Template (403) Template for a User Not Allowed (403) response
Not Found Template (404) Template for a Not Found (404) response
Method Not Allowed Template (405) Template for a Method Not Allowed (405) response
Internal Error Template (500) Template for a Internal Error (500) response

Attachments

Field Description
Handle Attachments If checked the web service will process attachments send by the client and attach them to the new or existing record
Attachment(s) JSON Field The JSON path to the attachment(s) in the JSON body
Attachment Filename JSON Field The JSON path that points to the file name. The JSON path is relative to the "Attachment(s) JSON Field" path
Attachment Content Type JSON Field The JSON path that points to the content type or mime type. The JSON path is relative to the "Attachment(s) JSON Field" path
Attachment Data JSON Field The JSON path that points to the (base 64 encoded) data. The JSON path is relative to the "Attachment(s) JSON Field" path

Paging

Only applicable for action "Provide Data"

Field Description
Paging When checked the web service will change the returned message to include paging information. Only a specific amount of records will be returned per call
Default Amount Per Page Amount of records to return per page

The result template will be changed to:

{
   "items": [],   // array containing records according to the template
   "start": 0,    // starting record
   "count": 20,   // amount of records returned
   "total": 100   // total records found using the condition configured in this web service
}

Query parameters

Parameter Description
start Specify the index of the first record to be returned
count Specify the maximum amount of records to be returned

Pre-processing

Field Description
Enable Pre-processing If checked the Pre-processing script will be used before the incoming message is processed
Pre-processing Script This script will run before the message is processed. The comments in the script will provide additional information

Advanced

Field Description
Use IRE Engine Use the IRE engine to import records into the CMDB
Enable Multiple Records Input Allow multiple reocrds to be send to and processed by this web service

UI Actions

Button Description
Create new version Create a copy of this web service with an increased version number

Using variables

In most fields variables can be used. Variables always start with ${ followed by the variable name and end with }. The list below lists all the default (internal) variables.

Variable Description
${url.parameter} Contains the last resource path in the URL
${url.x} Where x is an index (integer) and will return the x'th resource path
${query.x} Where x is a name (string) and will return the query parameter value
${header.x} Where x is a name (string) and will return the header value

Validation Rules

Create rules to validate the web service input. The input can be validated before or after mapping.

Field Description
Name Name the validation rule
Type Before mapping or After mapping
Web Service The web service this rule belongs to
Active True or false
Order The order of the rule
Condition The condition that will cause this rule to fail (Script or condition depending on the type)
Response Code The HTTP response code to return if the validation fails
Response Headers The response headers to return if the validation fails
Response Message The response body to return if the validation fails