This section covers the various terms that are used throughout the Service Virtualization APIs.

DSL

The dsl is the object that stores properties of Transactions.

There are multiple sources we support and convert to DSL format to use them as request/response transactions:

Supported dsl type keys are:

• SWAGGER2_DSL for Swagger Versions 2
• SWAGGER3_DSL for Swagger Versions 3
• CODESV_DSL for CodeSv
• WIREMOCK_DSL for Wiremock
• HAR_DSL for HTTP Archive format (HAR)
• TAURUS_RECORDING for TaurusRecording format
• RR_PAIR for R/R Pairs
• GENERIC_DSL

For more information, see Adding Transactions.

This appendix shows how to configure a dsl manually. The easiest way to create a valid dsl for an API call is to create a Transaction in the web interface and copy and paste the response.

 

To create a dsl manually, use the following format:

Attributes

• requestDslobject

  The request DSL details

  Show/Hide Child Attributes

  • methodstring

    required

    HTTP verb used for the request

    Sample Values
    POST
GET
PUT
PATCH
DELETE
OPTIONS
TRACE
HEAD
CONNECT
ANY

  • urlobject

    URL or regular expression to match

    Show/Hide Child Attributes

    • keystring

      Set this key to url to match URLs

      Sample Values
      url

    • matcherNamestring

      required

      Matcher operation to perform over given value

      Sample Values
      equals_url
matches_url
      
      Note: For Wiremock and url type only, matcherName additionally supports any; in this case, no matchingValue is required

    • matchingValuestring

      required

      Value to be matched.
      For type url, matchingValue is required and must be a valid URL for equals_url, or a valid regular expression for matches_url.
      For Wiremock with url type and matcherName any, matchingValue is not required

      Sample Values
      myurl.company.com

  • headersarray

    List of MatcherDsls that apply to header

    Show/Hide Child Attributes

    • keystring

      required

      HTTP header name to match, value not encoded

      Sample Values
      header1

    • matcherNamestring

      required

      Matcher operation to perform over given value

      Sample Values
      contains
matches
equals
equals_insensitive
not_matches
absent


    • matchingValuestring

      required

      Value to be matched

      Sample Values
      value1

  • queryParamsarray

    List of MatcherDsls that apply to query parameters

    Show/Hide Child Attributes

    • keystring

      required

      Query line parameter name to match, value not encoded

      Sample Values
      queryParam1

    • matcherNamestring

      required

      Matcher operation to perform over given value

      Sample Values
      contains
matches
equals
equals_insensitive
not_matches
absent

    • matchingValuestring

      required

      Value to be matched

      Sample Values
      value1

  • cookiesarray

    List of MatcherDsls that apply to cookies

    Show/Hide Child Attributes

    • keystring

      required

      Request cookie name to match, value not encoded

      Sample Values
      cookie1

    • matcherNamestring

      required

      Matcher operation to perform over given value

      Sample Values
      contains
matches
equals
equals_insensitive
not_matches
absent


    • matchingValuestring

      required

      Value to be matched

      Sample Values
      value1

  • credentialsobject

    Credentials to use for basic authentication

    Show/Hide Child Attributes

    • usernamestring

      The username for your credential

      Sample Values
      joe user

    • passwordstring

      The password for your credential

      Sample Values
      p455w0rd

  • bodyarray

    List of MatcherDsls that apply to body

    Show/Hide Child Attributes

    • matcherNamestring

      required

      Matcher operation to perform over given value

      Sample Values
      contains
equals
equals_insensitive
equals_json
matches_json
equals_xml
matches_xml
equals_binary
not_matches
absent

    • matchingValuestring

      required

      Value to be matched. Encode this value into base64

      Sample Values
      JFsnbWVudSddWydpZCdd

• responseDslobject

  The response DSL details

  Show/Hide Child Attributes

  • statusinteger

    Status response code

    Sample Values
    1xx information
    2xx success
    3xx redirection
    4xx server errors
    5xx client errors
    See HTTP Status Codes

  • statusMessagestring

    Status response message

    Sample Values
    "HTTP/1.1 200 OK"
    See HTTP Status Codes

  • proxyUrlstring

    URL of proxy server, if required

    Sample Values
    https://proxy.corp.com

  • headersarray

    Response header elements

    Sample Values
    "headers": [ { "name": "Content-Type", "value": "text/plain; charset=UTF-8" }

    Show/Hide Child Attributes

    • namestring

      The header name

      Sample Values
      Content-Type

    • valuestring

      The header value

      Sample Values
      text/plain; charset=UTF-8

  • binaryboolean

    Whether the response is in binary format

    Sample Values
    false
true

  • contentTypeboolean

    Content-type of the response body. See IANA.org

    Sample Values
    application/json
text/plain
text/xml, ...

  • contentstring

    The response body content to return. Encode this value into base64

    Sample Values
    SGVsbG8gd29ybGQhCg==

  • charsetstring

    The encoding used in response

    Sample Values
    UTF-8

{
  "priority": 0,
  "requestDsl": {
    "method": "POST",    
    "url": {
      "key": "url",
      "matcherName": "equals_url",
      "matchingValue": "http://www.example.com"
    },
    "headers": [
      {
        "key": "header1",
        "matcherName": "contains",
        "matchingValue": "value1"
      },
      {
        "key": "header2",
        "matcherName": "matches",
        "matchingValue": "value2"
      },
      {
        "key": "header3",
        "matcherName": "equals",
        "matchingValue": "value3"
      },
      {
        "key": "header4",
        "matcherName": "not_matches",
        "matchingValue": "value4"
      },
      {
        "key": "header5",
        "matcherName": "equals_insensitive",
        "matchingValue": "value5"
      },
      {
        "key": "header6",
        "matcherName": "absent",
        "matchingValue": "header6"
      }
    ],
    "queryParams": [
      {
        "key": "q1",
        "matcherName": "contains",
        "matchingValue": "q_value1"
      },
      {
        "key": "q2",
        "matcherName": "matches",
        "matchingValue": "q_value2"
      },
      {
        "key": "q3",
        "matcherName": "equals",
        "matchingValue": "q_value3"
      },
      {
        "key": "q4",
        "matcherName": "not_matches",
        "matchingValue": "q_value4"
      },
      {
        "key": "q5",
        "matcherName": "equals_insensitive",
        "matchingValue": "q_value5"
      },
      {
        "key": "q6",
        "matcherName": "absent",
        "matchingValue": "q6"
      }
    ],
    "cookies": [
      {
        "key": "cookie1",
        "matcherName": "contains",
        "matchingValue": "c_value1"
      },
      {
        "key": "cookie2",
        "matcherName": "matches",
        "matchingValue": "c_value2"
      },
      {
        "key": "cookie3",
        "matcherName": "equals",
        "matchingValue": "c_value3"
      },
      {
        "key": "cookie4",
        "matcherName": "not_matches",
        "matchingValue": "c_value4"
      },
      {
        "key": "cookie5",
        "matcherName": "equals_insensitive",
        "matchingValue": "c_value5"
      },
      {
        "key": "cookie6",
        "matcherName": "absent",
        "matchingValue": "cookie6"
      }
    ],
    "credentials": {
      "username": "joe user",
      "password": "p455w0rd"
    },
    "body": [
      {
        "matcherName": "matches_json",
        "matchingValue": "JFsnbWVudSddWydpZCdd"
      }
    ]
  },
  "responseDsl": {
    "status": 200,
    "statusMessage": "HTTP/1.1 200 OK",
    "headers": [
      {
        "name": "Content-Type",
        "value": "text/plain; charset=UTF-8"
      }
    ],
    "binary": false,
    "content": "ZXhhbXBsZSBwb3N0IHJlc3BvbnNl",
    "charset": "UTF-8"
  }
}

This identifier was used in MAR-based Mock Services (EOL) only.

Harbor ID

This identifier was used in MAR-based Mock Services (EOL) only. It defines the private on-premise location (aka 'harbor'), a logical container on the BlazeMeter end that contains one or more agents (aka 'ships') on your end.

Location ID

This is the unique identifier for a cloud location or a private location. It is used in the following APIs:

• Virtual Service Location
• Update Properties of a Virtual Service Template

It is found in the response of the following APIs:

• Get Location of a Workspace
• Get Virtual Service User Details

For another method for finding this value, see Get the Location Name.

Log ID

This is the unique identifier of a log. It is used in the following APIs:

• Get a Log file of a Virtual Service
• Update the Log Snapshot of a Virtual Service

It is found in the response of the following APIs:

• Take a Log Snapshot of a Virtual Service
• Refresh the Logs of a Virtual Service

Virtual Service ID

• Configure or Reconfigure Virtual Services
• Delete Virtual Services
• Deploy Virtual Services
• Get a Log File of a Virtual Service
• Take a Log Snapshot of a Virtual Service
• Update the Log Snapshot of a Virtual Service
• Get Virtual Service
• Stop a Virtual Service
• Delete Virtual Service Template
• Update Virtual Service Properties
• Update a Virtual Service

It is found in the response of the following APIs:

• Create Virtual Services

Virtual Service Template ID

This is the unique identifier of a Template. It is used in the following APIs:

• Delete Virtual Service Template
• Update Virtual Service Template Properties
• Update Virtual Service Template
• Apply Virtual Service Template to Virtual Service

It is found in the response of the following APIs:

• Create Virtual Service Template
• Get All Virtual Service Templates
• Get Virtual Service Template

Registry ID

This identifier was used in MAR-based Mock Services (EOL) only.

Request ID

This is the unique Virtual Service Request identifier for a given Virtual Service in a given Workspace.

It is found in the response of the following API call in the result id: {“result” : [ { “id” : 7777, ...} ] }:

• Get the Request ID of a Virtual Service (Analytics)

It is used in the following APIs:

• Request the Analytics of a Virtual Service

Service ID

This is the unique identifier of a Service. It is used in the following APIs:

• Get Service by ID
• Get All Virtual Services
• Update a Service
• Create Virtual Service Template
• Get All Virtual Service Templates
• Create Transaction From Sources
• Create Transaction
• Get All Transactions

It is found in the response of the following APIs:

• Create a Service
• Get All Services
• Update a Service
• Get Transaction

Ship ID

This identifier was used in MAR-based Mock Services (EOL) only. It defines a 'ship', an agent in a logical container on the BlazeMeter end in your private on-premise location (aka 'harbor').

Tag ID

This is the unique identifier of a tag. It is used in the following APIs:

• Delete Tag
• Get Tag by ID
• Update a Tag

It is found in the response of the following APIs:

• Create a Tag
• Get All Tags
• Get Tag by Name

Transaction ID

This is the unique identifier of a Transaction. It is used in the following APIs:

• Delete Transaction
• Get Transaction
• Update Transaction

It is found in the response of the following APIs:

• Create Transaction From Sources
• Create Transaction
• Get All Transactions
• Get All Conflicting Transactions

VSE ID (deprecated)

This identifier was used in MAR-based Mock Services (EOL) only.

Workspace ID

This is the unique identifier that identifies a Workspace. It is used in the following APIs:

• Configure and Deploy Virtual Services
• Configure or Reconfigure Virtual Services
• Create Virtual Services
• Delete Virtual Services
• Deploy Virtual Services
• Get All Virtual Services
• Get Workspace Location
• Get a Log File of a Virtual Service
• Take a Log Snapshot of a Virtual Service
• Update the Log Snapshot of a Virtual Service
• Get Virtual Service
• Create a Service
• Get All Services
• Get Service by ID
• Update a Service
• Stop a Virtual Service
• Create Virtual Service Template
• Get All Virtual Service Templates
• Get Virtual Service Template
• Update Virtual Service Template Properties
• Update Virtual Service Template
• Perform Bulk Operation Over Transactions
• Create Transaction From Sources
• Create Transaction
• Delete Transaction
• Get All Transactions
• Get All Conflicting Transactions
• Get Transaction
• Update Transaction
• Update Virtual Service Properties
• Update a Virtual Service
• Verify Taurus Configuration Dependencies

It is found in the response of the following APIs:

• Get Details of Currently Logged-In User

For another method for finding this value, see Get Your Workspace ID.

Project ID

This is the unique identifier that identifies a given project.