NAV Navbar
Home Performance Mock Services API Monitoring
cURL
  • Introduction
  • Mock Service Service REST API
  • Tag REST API
  • Transaction API
  • Mock Service REST API
  • Mock Service Template REST API
  • Tracking REST API
  • User Details REST API
  • Mock Service Location REST API
  • Mock Service Log REST API
  • Appendix
  • Introduction

    Welcome to the Mock Services section of the BlazeMeter API Reference! This reference provides information on accessing our API endpoints to automate the creation of mock services and transactions for your services.

    After verifying your application server is functioning as expected, you're ready to move on to simulating some tests. BlazeMeter CT's Mock Services allow you to test even when you don't have access to a full test environment. You can run a mock service to deploy transactions, which are typically a subset of transactions in a particular service. Once a mock service is created and running, you can associate it to your test, embed it in your test scripts, or provide it during test execution.

    This API reference uses the following conventions for your convenience:

    Overview

    Your Account provides access to different levels of the API:

    The following figure illustrates the relationship between the components.

    Authorization Using Basic Authentication

    Authorization

    curl 'https://a.blazemeter.com/api/v4/user' \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret'
    

    Response 200 OK

    {
      "api_version": 4,
      "error": null,
      "result": {
        "id": 123456,
        "email": "my.name@my_email.com",
        "access": 1522676762,
        "login": 1521724222,
        "firstName": "my",
        "lastName": "name",
        "timezone": 0,
        "enabled": true,
        "roles": [
          "user",
          "new-billing",
          "authenticated"
        ],
    
        •••
    
        }
      }
    }
    

    API Explorer: /user

    To use the BlazeMeter API, pass your BlazeMeter API key using Basic Authentication (Basic Auth) credentials. These credentials contain a Key ID and a Secret Key:

    id:secret

    For example: f817e22f1526b048799f75da:7641251982b983cfd92b5a25fa97cd3ee9e21920f21d8b14cd705831826935723f3033f0

    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. In the code sample, replace 'api_key_id:api_key_secret' with your credentials.

    Create the API Key

    Use the linked BlazeMeter article to create your API key.

    Mock Service Service REST API

    Create a Service

    To create a Service in your Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your workspace.

    The response contains a Service identifier that you should note down. You will need the serviceID when you want to configure, deploy, or delete this Service later.

    Minimum Parameters for Creating a Service

    The following parameters are the base parameters required to create Service.

    Create a Service Attributes (minimum)

    Create a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services' \
        -X POST \
        -H 'accept: */*' \
        -H 'authorization: Basic cnV0aC5rdXN0ZXJlckBicm9hZGNvbS5jb206Q2U1a3lsZTUh' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "This service handles foo.", "name": "My Foo Service"}'
    

    Create a Service Minimum Configuration Sample POST Body(JSON)

    {
      "description": "This service handles foo.",
      "name": "My Foo Service"
    }
    

    Response 201 Created

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 1645,
        "name": "My Foo Service",
        "description": "This service handles foo.",
        "created": 1563897852,
        "updated": 1563897852,
        "createdBy": "someone@example.com",
        "updatedBy": "someone@example.com"
      },
      "requestId": "ec0e40cf720bdbc4"
    }
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    description

    string

    Description of the Service.
    name

    string

    The name of the Service.

    Get All Services

    To get all Services of a Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for getting all Services

    The following parameters are the base parameters required to get all Services.

    Get All Services Attributes (minimum)

    Get All Services Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services?limit=5&skip=0&sort=name' \
        -X GET  \
        -H 'accept: */*' \
        -H 'authorization: Basic cnV0aC5rdXN0ZXJlckBicm9hZGNvbS5jb206Q2U1a3lsZTUh'
    

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": [
        {
          "id": 1619,
          "name": "Some Service",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        },
        {
          "id": 1618,
          "name": "Some other Service",
          "description": "A service that serves as an example",
          "created": 1563893804,
          "updated": 1563893804,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        }
      ],
      "requestId": null,
      "limit": 5,
      "skip": 0,
      "total": 2
    }
    

    Attribute Description
    limit

    integer

    Number of results per page.
    name

    string

    The Service name to filter by.
    skip

    integer

    Number of initial results to skip.
    sort

    string

    The column name to sort by: id, name, or description.
    workspaceId

    integer

    The Workspace identifier.

    required

    Get Service by ID

    To get a Service of your Workspace, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    Minimum Parameters for Getting a Service by its ID

    The following parameters are the base parameters required to get a Service by its ID.

    Get a Service Attributes (minimum)

    Get a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services/123' \
        -X GET \
        -H 'accept: */*' \
        -H 'authorization: Basic cnV0aC5rdXN0ZXJlckBicm9hZGNvbS5jb206Q2U1a3lsZTUh'
    

    Response 201 Created

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 123,
        "name": "My Foo Service",
        "description": "This service handles foo.",
        "created": 1563897852,
        "updated": 1563897852,
        "createdBy": "someone@example.com",
        "updatedBy": "someone@example.com"
      },
      "requestId": "d1cfe5c67b2ed26f"
    }
    


    Attribute Description
    serviceId

    string

    The Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Update a Service

    To update the name and description of an existing Service in your Workspace, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    Minimum Parameters for Updating a Service

    The following parameters are the base parameters required to update a Service.

    Update a Service Attributes (minimum)

    Update a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services/123' \
        -X PUT \
        -H 'accept: */*' \
        -H 'authorization: Basic cnV0aC5rdXN0ZXJlckBicm9hZGNvbS5jb206Q2U1a3lsZTUh'
        -H "Content-Type: application/json"
        -d '{ "description": "A service that handles foo", "id": 1645, "name": "My foo service"}'
    

    Response 201 Created

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 123,
        "name": "My Foo Service",
        "description": "This service handles foo.",
        "created": 1563897852,
        "updated": 1563897852,
        "createdBy": "someone@example.com",
        "updatedBy": "someone@example.com"
      },
      "requestId": "d1cfe5c67b2ed26f"
    }
    


    Attribute Description
    serviceId

    string

    The Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    description

    string

    The new description of the updated Service.

    required

    name

    string

    The new name of the updated Service.

    required

    Tag REST API

    You can categorize Transactions and Services by applying Tags of your choice. These tags are available in searches and filters.

    Create a Tag

    You can use tags when you search and filter Transactions or Services. The creation response contains a tag identifier that you should note down. You will need the tagID when you want to configure, deploy, or delete this tag later.

    Minimum Parameters for creating a tag

    The following parameters are the base parameters required to create a tag.

    Create a Tag Attributes (minimum)

    Create a Tag Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/tags' \
       -X POST /
       -H 'accept: */*' /
       -H 'Content-Type: application/json' /
       -d '{ "description": "payment service category", "name": "pay"}'
    

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 888,
        "name": "pay",
        "description": "payment service category",
        "created": 1564147307,
        "updated": 1564147307,
        "createdBy": "somebody@example.com",
        "updatedBy": "somebody@example.com"
      },
      "requestId": "acb25df0e22ec097"
    }
    

    Attribute Description
    description

    string

    The description of the tag category.
    name

    string

    The name of the tag that can be used in searches and filters.

    Get All Tags

    You can use tags when you search and filter Transactions or Services.

    Minimum Parameters for getting all tags

    The following parameters are the base parameters required to get all tags.

    Get All Tags Attributes (minimum)

    Get All Tags Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/tags?limit=10&skip=0&sort=name' \
       -X GET \
       -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": [
        {
          "id": 163,
          "name": "prod",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "somebody@example.com",
          "updatedBy": "somebody@example.com"
        },
        {
          "id": 162,
          "name": "test",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "somebody@example.com",
          "updatedBy": "somebody@example.com"
        },
        {
          "id": 203,
          "name": "dev",
          "description": "tag description",
          "created": 1563980513,
          "updated": 1563980513,
          "createdBy": "somebody@example.com",
          "updatedBy": "somebody@example.com"
        }
      ],
      "requestId": null,
      "limit": 10,
      "skip": 0,
      "total": 3
    }
    

    Attribute Description
    limit

    integer

    The number of results per page.
    skip

    integer

    The number of initial results to skip.
    sort

    string

    The column name to sort by: id, name, or description.

    Get Tag by ID

    To get a tag, you need to know either the tag identifier or its name. The sample code uses a tagId of 888. Use the actual ID values of your tag.

    Minimum Parameters for Getting a Tag by ID

    The following parameters are the base parameters required to get a tag by its ID.

    Get Tag by ID Attributes (minimum)

    Get Tag by ID Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/tags/888' \
        -X GET \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 888,
        "name": "pay",
        "description": "payment service category",
        "created": 1563980513,
        "updated": 1563980513,
        "createdBy": "somebody@example.com",
        "updatedBy": "somebody@example.com"
      },
      "requestId": "ee47a7b219e3a9e5"
    }
    

    Attribute Description
    tagId

    integer

    The tag identifier.

    required

    Get Tag by Name

    To get a tag, you need to know either the tag name or its identifier. The sample code uses a name of pay. Use the actual name of your tag.

    Minimum Parameters for Getting a Tag by Name

    The following parameters are the base parameters required to get a tag by its name.

    Get Tag by Name Attributes (minimum)

    Get Tag by Name Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/tags/name/pay' \
        -X GET \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 288,
        "name": "pay",
        "description": "payment service category",
        "created": 1564147307,
        "updated": 1564147307,
        "createdBy": "somebody@example.com",
        "updatedBy": "somebody@example.com"
      },
      "requestId": "ee47a7b219e3a9e5"
    }
    

    Attribute Description
    name

    string

    The tag name.

    required

    Update a Tag

    To update the name or description of an existing tag, you need to know the tag identifier. The sample code uses a tagId of 888. Use the actual ID value of your tag.

    Minimum Parameters for Updating a Tag

    The following parameters are the base parameters required to update a tag.

    Update a Tag Attributes (minimum)

    Update a Tag Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/tags/888' \
       -X PUT \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "description": "task tracker", "id": 888, "name": "tasks"}'
    

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-26T13:42:48.750Z",
        "createdBy": "somebody@example.com",
        "description": "task tracker",
        "id": 888,
        "name": "tasks",
        "updated": "2019-07-26T13:42:48.750Z",
        "updatedBy": "somebody@example.com"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    description

    string

    The description of the tag.
    id

    integer

    The identifier of the tag.
    name

    string

    The name of the tag.

    Delete Tag

    To delete a tag, you need to know the tag identifier. The sample code uses a tagId of 888. Use the actual ID value of your tag.

    Minimum Parameters for Deleting a Tag

    The following parameters are the base parameters required to delete a tag.

    Delete a Tag Attributes (minimum)

    Delete a Tag Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/tags/888' \
        -X DELETE \
        -H 'accept: */*'
    

    Response 200 OK

    {
    }
    

    Attribute Description
    tagId

    string

    The tag identifier.

    required

    Transaction API

    A Transaction is a request/response pair that is associated with a given Service. A Transaction contains one or more request patterns and hard-coded responses. You typically create a custom catalog of mock Transactions for each Service. When you create a Mock Service, you assign Transactions from your catalog to the Mock Service.

    Transaction Types (DSL)

    The dsl is the object that stores properties of Transactions. Supported dsl type keys are GENERIC_DSL, CODESV_DSL, WIREMOCK_DSL, HAR_DSL, SWAGGER2_DSL, SWAGGER3_DSL, TAURUS_RECORDING, RR_PAIR. For more information, see Adding Transactions.

    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.

    Create Transaction

    To create a Transaction, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    The response contains an identifier that you should note down. You will need this transactionID when you want to configure, deploy, or delete this Transaction later.

    Minimum Parameters for creating a Transaction

    The following parameters are the base parameters required to create a Transaction.

    Create a Transaction Attributes (minimum)

    Create a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/26208/transactions?serviceId=1645' \
      -X POST \
      -H 'accept: */*' \
      -H 'Content-Type: application/json' \
      -d '{ "transactions":
               [ \
                  {
                      "description": "string", \
                      "dsl": { \
                            "priority": 1, \
                            "requestDsl": { \
                              "method": "GET", \
                              "host": "http://miurl.com.ec", \
                              "path": "", \
                              "url": { \
                                "key": "url", \
                                "matcherName": "equals_url", \
                                "matchingValue": "miurl.com.ec" \
                              }, \
                              "headers": [], \
                              "queryParams": [], \
                              "cookies": [], \
                              "credentials": {}, \
                              "body": [] \
                            }, \
                            "responseDsl": { \
                              "status": 200, \
                              "statusMessage": "OK", \
                              "proxyUrl": "", \
                              "headers": [], \
                              "binary": false, \
                              "contentType": "json", \
                              "content": "", \
                              "charset": "UTF-8" \
                            } \
                          } \
                      "id": 0, \
                      "link": "string", \
                      "name": "string", \
                      "serviceId": 0, \
                      "serviceName": "string", \
                      "tags": [ "string" ]
                  }
               ]
          }'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "description": "string",
        "dsl": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "id": 0,
        "link": "string",
        "name": "string",
        "serviceId": 0,
        "serviceName": "string",
        "tags": [
          "string"
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    serviceId

    string

    The Service identifier.

    required

    Create Transaction From Sources

    To create a Transaction from a source file, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    The creation response contains an identifier that you should note down. You will need the transactionID when you want to configure, deploy, or delete this Transaction later.

    Minimum Parameters for creating a Transaction

    The following parameters are the base parameters required to create a Transaction.

    Create a Transaction Attributes (minimum)

    Create a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions' \
       -X POST \
       -H 'accept: */*' \
       -H 'Content-Type: multipart/form-data' \
       -F 'serviceId=123' \
       -F 'verbose=true'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "description": "string",
          "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
          "id": 0,
          "link": "string",
          "name": "string",
          "serviceId": 123,
          "serviceName": "string",
          "tags": [
            "string"
          ]
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    serviceId

    string

    The Service identifier.

    required

    Import Transactions

    Use this API to upload files of Transactions to lists of generic DSLs that can be used in BlazeMeter. Supported file formats are .json, .yml, .yaml, .har, .zip.

    Minimum Parameters for Importing Transactions

    The following parameters are the base parameters required to import Transactions.

    Import Transactions Attributes (minimum)

    Import Transactions Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/transactions/convert?verbose=true' \
       -X POST \
       -H 'accept: */*' \
       -H 'Content-Type: multipart/form-data' \
       -F 'file=@my-swagger.json;type=text/json'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "nativeId": "string",
          "priority": 0,
          "requestDsl": {
            "body": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "cookies": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "credentials": {
              "password": "string",
              "username": "string"
            },
            "headers": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "host": "string",
            "method": "string",
            "path": "string",
            "queryParams": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "url": {
              "key": "string",
              "matcherName": "string",
              "matchingValue": "string"
            }
          },
          "responseDsl": {
            "binary": true,
            "charset": "string",
            "content": "string",
            "contentType": "JSON",
            "headers": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "proxyUrl": "string",
            "status": 0,
            "statusMessage": "string"
          }
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    verbose

    boolean

    Whether to include extra elements, such as Headers, when importing and converting the transactions from the file.

    Get Transaction

    To get a Transaction, you need to know your Workspace identifier and the Transaction identifier. The sample code uses a transactionId of 77 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for getting a Transaction

    The following parameters are the base parameters required to get a Transaction.

    Get a Transaction Attributes (minimum)

    Get a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions/77' \
        -X GET \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "description": "string",
        "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
        "id": 0,
        "link": "string",
        "name": "string",
        "serviceId": 0,
        "serviceName": "string",
        "tags": [
          "string"
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    transactionId

    string

    The transaction identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    type

    string

    The Transaction type (dsl) to filter by.

    Get All Transactions

    To get all Transactions within a Service, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    You can filter Transactions by a (sub)string, Transaction name, Service Mock identifier, workspaceId, custom Tags, or Transaction type (dsl).

    Minimum Parameters for getting all Transactions

    The following parameters are the base parameters required to get all Transactions.

    Get All Transactions Attributes (minimum)

    Get All Transactions Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions?serviceId=123' \
        -X GET \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "description": "string",
          "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
          "id": 0,
          "link": "string",
          "name": "string",
          "serviceId": 123,
          "serviceName": "string",
          "tags": [
            "string"
          ]
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceMockId

    integer

    The identifier of the Service Mock whose Transaction you want to get.
    serviceId

    string

    The identifier of the Service whose Transaction you want to get.

    required

    workspaceId

    string

    The identifier of the Workspace whose Transaction you want to get.

    required

    filter

    string

    Text by which you want to filter the query result.
    limit

    integer

    Number of results per page.
    query

    string

    Name of the Transaction to get.
    skip

    integer

    Number of initial results to skip.
    sort

    string

    The column name by which you want to sort the result: id, name, or description.
    tags

    string

    Tags by which you want to filter the result.
    type

    string

    Transaction type (dsl) by which you want to filter the result.

    Perform Bulk Operation Over Transactions

    To perform a bulk delete or tag operation over several Transactions in a Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for bulk operations

    The following parameters are the base parameters required to perform bulk operations.

    Bulk Operations Attributes (minimum)

    Bulk Operations Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions' \
      -X PATCH \
      -H 'accept: */*' \
      -H 'Content-Type: application/json' \
      -d '{ "action": "DELETE", "tags": [ "some_category" ], "transactions": [ 0 ]}'
    

    Response 200 OK

    {
      "body": {},
      "statusCode": "100 CONTINUE",
      "statusCodeValue": 0
    }
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    action

    string

    The bulk action. Possible values: DELETE, TAG.

    required

    tags

    string

    The tag to apply to the listed Transactions. Used together with the TAG action.
    transactions

    list

    List of Transactions.

    Update Transaction

    To update an existing Transaction in your Workspace, you need to know your Workspace identifier and the Transaction identifier. The sample code uses a transactionId of 77 and a workspaceId of 123456. Use the actual ID values of your workspace and Transaction.

    Minimum Parameters for Updating a Transaction

    The following parameters are the base parameters required to update a Transaction.

    Update a Transaction Attributes (minimum)

    Update a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions/77' \
       -X PUT \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "description": "string",
             "dsl": { \
                    "priority": 1, \
                    "requestDsl": { \
                      "method": "GET", \
                      "host": "http://miurl.com.ec", \
                      "path": "", \
                      "url": { \
                        "key": "url", \
                        "matcherName": "equals_url", \
                        "matchingValue": "miurl.com.ec" \
                      }, \
                      "headers": [], \
                      "queryParams": [], \
                      "cookies": [], \
                      "credentials": {}, \
                      "body": [] \
                    }, \
                    "responseDsl": { \
                      "status": 200, \
                      "statusMessage": "OK", \
                      "proxyUrl": "", \
                      "headers": [], \
                      "binary": false, \
                      "contentType": "json", \
                      "content": "", \
                      "charset": "UTF-8" \
                    } \
                  } \
             "id": 0, \
             "link": "string", \
             "name": "string", \
             "serviceId": 0, \
             "serviceName": "string", \
             "tags": [ "string" ]
           }'
    

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:07:03.541Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-24T16:07:03.541Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    


    Attribute Description
    workspaceId

    integer

    The Workspace identifier.
    transactionId

    integer

    The Transaction identifier.

    Delete Transaction

    To delete a Transaction, you need to know the Transaction identifier and your Workspace identifier. The sample code uses a transactionId of 888 and a workspaceId of 123456. Use the actual ID value of your Transaction.

    Minimum Parameters for Deleting a Transaction

    The following parameters are the base parameters required to delete a Transaction.

    Delete a Transaction Attributes (minimum)

    Delete a Transaction Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions/77' \
        -X DELETE \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "body": {},
      "statusCode": "100 CONTINUE",
      "statusCodeValue": 0
    }
    

    Attribute Description
    workspaceId

    integer

    The Workspace identifier.

    required

    transactionId

    integer

    The Transaction identifier.

    required

    Get All Conflicting Transactions

    To get all conflicting Transactions from a Service, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    Minimum Parameters for getting all conflicting Transactions

    The following parameters are the base parameters required to get all conflicting Transactions.

    Get All Conflicting Transactions Attributes (minimum)

    Get All Conflicting Transactions Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com//api/v1/workspaces/123456/transactions/conflicts' \
        -X GET \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "additionalProp1": [
          {
            "description": "string",
            "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
            "id": 0,
            "link": "string",
            "name": "string",
            "serviceId": 0,
            "serviceName": "string",
            "tags": [
              "string"
            ]
          }
        ],
        "additionalProp2": [
          {
            "description": "string",
            "dsl": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "id": 0,
            "link": "string",
            "name": "string",
            "serviceId": 0,
            "serviceName": "string",
            "tags": [
              "string"
            ]
          }
        ],
        "additionalProp3": [
          {
            "description": "string",
            "dsl": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "id": 0,
            "link": "string",
            "name": "string",
            "serviceId": 123,
            "serviceName": "string",
            "tags": [
              "string"
            ]
          }
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceId

    string

    The Service identifier.
    workspaceId

    string

    The Workspace identifier.

    required

    limit

    integer

    Number of results per page.
    skip

    integer

    Number of initial results to skip.

    Mock Service REST API

    You can create a Mock Service that stands in for a live service for testing purposes.

    Create Mock Services

    To create a Mock Service in your workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    The response contains a Mock Service identifier that you should note down. You will need this mockServiceID when you want to configure, deploy, or delete this Mock Service later.

    Minimum Parameters for creating a Mock Service

    The following parameters are the base parameters required to create a Mock Service.

    Create a Mock Service Attributes (minimum)

    Create a Mock Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks' \
      -X POST /
      -H 'accept: application/json;charset=UTF-8' /
      -H 'Content-Type: application/json' /
      -d '{ "description": "string", /
            "endpointPreference": "string", /
            "harborId": "string", /
            "id": 0,/
            "liveSystemHost": "string", /
            "liveSystemPort": 0, /
            "name": "string", /
            "noMatchingRequestPreference": "string", /
            "noMatchingRequestTxnId": 0, /
            "serviceId": 123, /
            "shipId": "string", /
            "thinkTime": 0, /
            "transactionIds": [ 0 ]}'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T15:47:05.168Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-24T15:47:05.168Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    description

    string

    The description of the new Mock Service.
    endpointPreference

    string

    Choose HTTP or HTTPS.
    harborId

    string

    The identifier of 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.
    liveSystemHost

    string

    The host of the live system.
    liveSystemPort

    integer

    The port of the live system.
    name

    string

    The name of the new Mock Service.
    noMatchingRequestPreference

    string

    What to do if there are no matching requests. Choose either return404 to return "no match found", or choose bypasslive to redirect to the live system.
    noMatchingRequestTxnId

    integer

    If there are no matching requests, this is the Transaction ID that did not match.
    serviceId

    integer

    The identifier of an existing Service that contains this Mock Service.
    shipId

    string

    The identifier of a 'ship', an agent in a logical container on the BlazeMeter end in your private on-premise location (aka 'harbor').
    thinkTime

    integer

    Think time is a synthetic delay inserted between test steps to ensure the test script moves at a human pace.
    transactionIds

    list

    The Transaction identifiers that are assigned to this Mock Service. You can leave the list empty and assign Transactions later.

    Get All Mock Services

    To get all Mock Services, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    You can filter by workspaceId and serviceId.

    Minimum Parameters for getting all Mock Services

    The following parameters are the base parameters required to get all Mock Services.

    Get All Mock Services Attributes (minimum)

    Get All Mock Services Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/26208/service-mocks?serviceId=123' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'authorization: Basic cnV0aC5rdXN0ZXJlckBicm9hZGNvbS5jb206Q2U1a3lsZTUh'
    

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": [
        {
          "id": 1619,
          "name": "Some Service",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        },
        {
          "id": 1618,
          "name": "Some other Service",
          "description": "A service that serves as an example",
          "created": 1563893804,
          "updated": 1563893804,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        }
      ],
      "requestId": null,
      "limit": 5,
      "skip": 0,
      "total": 2
    }
    

    Attribute Description
    limit

    integer

    Number of results per page.
    name

    string

    The Service name to filter by.
    skip

    integer

    Number of initial results to skip.
    sort

    string

    The column name to sort by: id, name, or description.
    workspaceId

    integer

    The Workspace identifier.

    required

    Get Mock Service

    To get a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Getting a Mock Service

    The following parameters are the base parameters required to get a Mock Service.

    Get Mock Service Attributes (minimum)

    Get Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:06:01.427Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-24T16:06:01.427Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Update a Mock Service

    To update an existing Mock Service in your Workspace, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Updating a Mock Service

    The following parameters are the base parameters required to update a Mock Service.

    Update a Mock Service Attributes (minimum)

    Update a Mock Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X PUT \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "string", \
              "endpointPreference": "string", \
              "harborId": "string", \
              "id": 0, \
              "liveSystemHost": "string", \
              "liveSystemPort": 0, \
              "name": "string", \
              "noMatchingRequestPreference": "string", \
              "noMatchingRequestTxnId": 0, \
              "serviceId": 0, \
              "shipId": "string", \
              "thinkTime": 0, \
              "transactionIds": [ 0 ]}'
    

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:07:03.541Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-24T16:07:03.541Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    description

    string

    The updated description of the Mock Service.
    endpointPreference

    string

    Choose HTTP or HTTPS.
    harborId

    string

    The identifier of 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.
    id

    integer

    The identifier of the Mock Service that you want to update.
    liveSystemHost

    string

    The host of the live system.
    liveSystemPort

    integer

    The port of the live system.
    name

    string

    The updated name of the Mock Service.
    noMatchingRequestPreference

    string

    What to do if there are no matching requests. Choose either return404 to return "no match found", or choose bypasslive to redirect to the live system.
    noMatchingRequestTxnId

    integer

    If there are no matching requests, this is the Transaction ID that did not match.
    serviceId

    integer

    The identifier of the Service.
    shipId

    string

    The identifier of a 'ship', an agent in a logical container on the BlazeMeter end in your private on-premise location (aka 'harbor').
    thinkTime

    integer

    Think time is a synthetic delay inserted between test steps to ensure the test script moves at a human pace.
    transactionIds

    list

    The updated list of identifiers of Transactions used in this Mock Service.

    Delete Mock Services

    To delete a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Deleting a Mock Service

    The following parameters are the base parameters required to delete a Mock Service.

    Delete Mock Service Attributes (minimum)

    Delete Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X DELETE \
        -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    {
      "body": {},
      "statusCode": "100 CONTINUE",
      "statusCodeValue": 0
    }
    

    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Update Mock Service Properties

    To update properties of an existing Mock Service in your Workspace, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Updating Mock Service Properties

    The following parameters are the base parameters required to update Mock Service properties.

    Update Mock Service Properties Attributes (minimum)

    Update a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X PATCH \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "string", \
              "endpointPreference": "string", \
              "harborId": "string", \
              "name": "string", \
              "serviceId": 0, \
              "shipId": "string", \
              "status": "STOPPED", \
              "transactionIds": [ 0 ]\
            }'
    

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:21:44.603Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-24T16:21:44.603Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    


    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    description

    string

    The description of the Mock Service.
    endpointPreference

    string

    Choose HTTP or HTTPS.
    harborId

    string

    The identifier of 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.
    serviceId

    integer

    The identifier of the Service.
    shipId

    string

    The identifier of a 'ship', an agent in a logical container on the BlazeMeter end in your private on-premise location (aka 'harbor').
    name

    string

    The name of the Mock Service.
    status

    string

    You can set the status of a Mock Service to one of the following: STOPPED, RUNNING, CONFIGURING, FAILED (Service Mock initialization failed).
    transactionIds

    list

    The list of identifiers of the new Transactions used in this Mock Service.

    Deploy Mock Services

    Use this request to deploy a container based on the Mock Service if it has not already been deployed.

    To deploy a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Deploying a Mock Service

    The following parameters are the base parameters required to deploy a Mock Service.

    Deploy Mock Service Attributes (minimum)

    Deploy Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/deploy' \
      -X GET \
      -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "trackingId": "string",
        "trackingUrl": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Change the Status of a Mock Service

    To change the status of a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Submit the status value in the body. The status of a Mock Service is one of the following: STOPPED, RUNNING, CONFIGURING, FAILED (Service Mock initialization failed).

    Minimum Parameters for Stopping a Mock Service

    The following parameters are the base parameters required to stop a Mock Service.

    Stop Mock Service Attributes (minimum)

    Stop Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/status' \
        -X POST \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d 'STOPPED'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": true,
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Configure and Deploy Mock Services

    To configure or deploy Mock Services, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for Configuring/Deploying Mocks

    The following parameters are the base parameters required to configure/deploy Mock Services.

    Configure/Deploy Mocks Attributes (minimum)

    Configure/deploy Mocks Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/configure' \
        -X POST \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "dependencies": \
                { "services": \
                    [ { "service": "PayPal", \
                        "mock-service": "PPRunner", \
                        "transactions": \
                            [ "getAccounts", "getBalances", "createAccount" ] \
                      }, \
                      { "service": "WesternUnion", \
                        "mock-service": "WURunner", \
                        "transaction-filter": \
                            { "tags": \
                                [ "dev", "stage" ] \
                            } \
                      }, \
                      { "service": "Facebook", \
                        "mock-service": "FBRunner", \
                        "mock-service-template": "FBRunnerTemplate" \
                      } \
                    ] \
                } \
            }'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "trackingId": "string",
        "trackingUrl": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    Configure or Reconfigure Mock Services

    To configure or reconfigure an existing Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Configuring a Mock Service

    The following parameters are the base parameters required to configure a Mock Service.

    Configure Mock Service Attributes (minimum)

    Configure Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/configure' \
      -X GET \
      -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "trackingId": "string",
        "trackingUrl": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Verify Taurus Configuration Dependencies

    To validate Taurus configuration dependencies, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for Validation

    The following parameters are the base parameters required to validate Mock Services.

    Validate Mock Services Attributes (minimum)

    Validate Mock Services Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/validate' \
        -X POST \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "dependencies": \
                { "services": \
                    [ { "service": "PayPal", \
                        "mock-service": "PPRunner", \
                        "transactions": \
                            [ "getAccounts", "getBalances", "createAccount" ] \
                      }, \
                      { "service": "WesternUnion", \
                        "mock-service": "WURunner", \
                        "transaction-filter": \
                            { "tags": \
                                [ "dev", "stage" ] \
                            } \
                      }, \
                      { "service": "Facebook", \
                        "mock-service": "FBRunner", \
                        "mock-service-template": "FBRunnerTemplate" \
                      } \
                    ] \
                } \
            }'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "dependencies": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    Mock Service Template REST API

    Create Mock Service Template

    To create a Mock Service templates, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    The response contains a template identifier that you should note down. You will need the ID when you want to configure, deploy, or delete this template later.

    Minimum Parameters for creating a Mock Service template

    The following parameters are the base parameters required to create a Mock Service template.

    Create Mock Service Template Attributes (minimum)

    Create Mock Service Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates?serviceId=123' \
        -X POST \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d '{ "created": "2019-07-25T13:20:53.808Z",  \
              "createdBy": "string",  \
              "description": "string",  \
              "liveSystemHost": "string",  \
              "liveSystemPort": 0,  \
              "name": "string",  \
              "noMatchingRequestPreference": "string",  \
              "noMatchingRequestTxnId": 0,  \
              "thinkTime": 0,  \
              "transactionIds": [ 0 ],  \
              "updated": "2019-07-25T13:20:53.808Z",  \
              "updatedBy": "string" \
            }''
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:25:10.373Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-25T13:25:10.373Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    description

    string

    The description of the Mock Service.
    endpointPreference

    string

    Choose HTTP or HTTPS.
    harborId

    string

    The identifier of 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.
    id

    integer

    The identifier of the Mock Service.
    liveSystemHost

    string

    The host of the live system.
    liveSystemPort

    integer

    The port of the live system.
    name

    string

    The name of the Mock Service.
    noMatchingRequestPreference

    string

    What to do if there are no matching requests. Choose either return404 to return "no match found", or choose bypasslive to redirect to the live system.
    noMatchingRequestTxnId

    integer

    If there are no matching requests, this is the Transaction ID that did not match.
    updatedBy

    string

    Name of the last user who updated the template.
    updated

    date

    The time when this template was updated.
    thinkTime

    integer

    Think time is a synthetic delay inserted between test steps to ensure the test script moves at a human pace.
    transactionIds

    list

    The identifiers of the Transactions that this Mock Service uses.

    Get All Mock Service Templates

    To get all Mock Service templates, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    You can filter templates by workspaceId.

    Minimum Parameters for getting all Mock Service templates

    The following parameters are the base parameters required to get all Mock Service templates.

    Get All Mock Service Templates Attributes (minimum)

    Get All Mock Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates?serviceId=123' \
        -X GET  \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "created": "2019-07-25T13:25:10.347Z",
          "createdBy": "string",
          "description": "string",
          "id": 0,
          "liveSystemHost": "string",
          "liveSystemPort": 0,
          "name": "string",
          "noMatchingRequestPreference": "string",
          "noMatchingRequestTxnId": 0,
          "serviceId": 0,
          "serviceName": "string",
          "thinkTime": 0,
          "transactionIds": [
            0
          ],
          "updated": "2019-07-25T13:25:10.347Z",
          "updatedBy": "string"
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceId

    string

    The Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Get Mock Service Template

    To get a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for getting a Mock Service template

    The following parameters are the base parameters required to get a Mock Service template.

    Get a Mock Service Template Attributes (minimum)

    Get a Mock Service Template Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X GET \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:36:44.158Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-25T13:36:44.158Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceMockTemplateId

    string

    The Mock Service template identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Update Mock Service Template

    To update a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for updating a Mock Service template

    The following parameters are the base parameters required to update Mock Service templates.

    Update Mock Service Template Attributes (minimum)

    Update Mock Service Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X PUT \
        -H 'Content-Type: application/json' \
        -d '{ "created": "2019-07-25T13:41:28.547Z",
              "createdBy": "string",
              "description": "string",
              "liveSystemHost": "string",
              "liveSystemPort": 0,
              "name": "string",
              "noMatchingRequestPreference": "string",
              "noMatchingRequestTxnId": 0,
              "thinkTime": 0,
              "transactionIds": [ 0 ],
              "updated": "2019-07-25T13:41:28.547Z",
              "updatedBy": "string"
            }'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:45:01.191Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-25T13:45:01.191Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    description

    string

    The description of the Mock Service template.
    endpointPreference

    string

    Choose HTTP or HTTPS.
    harborId

    string

    The identifier of 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.
    id

    integer

    The identifier of the Mock Service template.
    liveSystemHost

    string

    The host of the live system.
    liveSystemPort

    integer

    The port of the live system.
    name

    string

    The name of the Mock Service.
    noMatchingRequestPreference

    string

    What to do if there are no matching requests. Choose either return404 to return "no match found", or choose bypasslive to redirect to the live system.
    noMatchingRequestTxnId

    integer

    If there are no matching requests, this is the Transaction ID that did not match.
    updatedBy

    integer

    Name of the last user who updated the template.
    updated

    date

    When this template was updated.
    Think time is a synthetic delay inserted between test steps to ensure the test script moves at a human pace.
    transactionIds

    list

    The new identifiers of the Transactions that you want to use in this Mock Service.

    Delete Mock Service Template

    To delete a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for deleting a Mock Service template

    The following parameters are the base parameters required to delete a Mock Service template.

    Delete a Mock Service Template Attributes (minimum)

    Delete a Mock Service Template Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X DELETE \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    serviceMockTemplateId

    string

    The Mock Service template identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    Update Mock Service Template Properties

    To update the properties of a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for updating a Mock Service template

    The following parameters are the base parameters required to update Mock Service templates.

    Update Mock Service Template Attributes (minimum)

    Update Mock Service Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X PATCH \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "string", \
              "location": "string", \
              "name": "string",\
              "transactionIds": [ 0 ] \
            }'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:51:48.016Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "transactionIds": [
          0
        ],
        "updated": "2019-07-25T13:51:48.016Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    description

    string

    The description of the template.
    location

    string

    The location of the Service, for example "cloud", "us-east-1", or "London".
    name

    string

    The name of the template.
    transactionIds

    list

    The identifiers of the Transactions used in this Mock Service.

    Tracking REST API

    Blazemeter sends the configuration with the Taurus definition to Mock Services component to create and run tests. The results of all these processes (fail or success) are saved. Use the UUID and the tracking API to see detailed results.

    Get Tracking by UUID

    To get tracking for Taurus, you need a universally unique identifier (uuid). The sample code uses a uuid of abcde. Use the actual ID value for your Taurus tracking.

    Minimum Parameters for getting tracking

    The following parameters are the base parameters required to get tracking.

    Get Tracking Attributes (minimum)

    Get Tracking Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/trackings/abcde' \
        -X GET \
        -H 'accept: */*'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-29T14:36:27.205Z",
        "createdBy": "string",
        "data": {
          "dataType": "CONFIGURATION",
          "values": [
            0
          ]
        },
        "ended": "2019-07-29T14:36:27.210Z",
        "errors": [
          "string"
        ],
        "id": "abcde",
        "status": "PENDING",
        "updated": "2019-07-29T14:36:27.210Z",
        "updatedBy": "string",
        "uuid": "string",
        "warnings": [
          "string"
        ],
        "workspaceId": 0
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    uuid

    string

    The tracking identifier.

    required

    User Details REST API

    Get Details of Currently Logged-In User

    You can get information about the currently logged-in user, such as name, email address, account and Workspace identifiers, roles, and URLs.

    Get User Info Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/user' \
        -X GET\
        -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "user": {
          "displayName": "Bertha Benz",
          "enabled": true,
          "activeAccountId": 23141,
          "preferencesId": "5d31e3793706bc000e179436",
          "activeWorkspaceId": 26208,
          "roles": [
            "user",
            "new-billing",
            "authenticated"
          ],
          "visitedMockServices": true,
          "email": "someone@example.com",
          "userId": 123456,
          "firstName": "Bertha",
          "lastName": "Benz",
          "defaultProjectId": 23456,
          "defaultAccountId": 34567,
          "defaultAccountName": "Default Account",
          "defaultWorkspaceName": "Default workspace",
          "defaultWorkspaceId": 45678,
          "defaultProjectCreatedAt": "2019-07-19T15:36:25Z",
          "account": {
            "features": {
              "enableContainersRoutes": false,
              "privateData": false,
              "enableNTCMockServicesPanel": true
            },
            "hasPrivateLocations": false
          },
          "workspaces": [
            {
              "id": 56789,
              "name": "Default workspace",
              "enabled": true,
              "dedicatedIpsEnabled": true,
              "privateLocationsEnabled": true
            }
          ]
        },
        "config": {
          "mixPanelToken": "352201717d6babc073fc10a878d730ca",
          "blazeMeterAppUrl": "https://a.blazemeter.com//app/",
          "blazeMeterApiUrl": "https://a.blazemeter.com//api/v4/",
          "personalSettingsUrl": "https://a.blazemeter.com//app/personal-settings",
          "logoutUrl": "https://a.blazemeter.com//app/logout",
          "inviteUrl": "https://a.blazemeter.com//app/invite",
          "accountSettingsUrl": "https://a.blazemeter.com//app/#/settings/personal",
          "menu": {
            "performance": "https://a.blazemeter.com//app/performance",
            "functional": "https://a.blazemeter.com//app/functional",
            "runscope": "https://a.blazemeter.com//app/api-monitoring",
            "sv": "https://a.blazemeter.com//app/mock-services"
          }
        }
      },
      "requestId": "fa979b4106ad5497"
    }
    

    Set Preferences of Currently Logged-In User

    You can change the preference settings of the currently logged-in user. Provide the field name and the new value in the body. Look up available field names in the user details.

    Set User Preferences Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com//api/v1/user/preferences' \
       -X PATCH \
       -H 'accept: application/json;charset=UTF-8' \
       -H 'Content-Type: application/json' \
       -d '{ "attributename": false }'
    

    Mock Service Location REST API

    You can label Workspaces with a unique identifier for a cloud location or a private location, for example "cloud", "us-east-1", or "London".

    Get Location of a Workspace

    To get the location of your Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    This call returns the Location identifier of your workspace.

    Minimum Parameters for Getting the Location of a Workspace

    The following parameters are the base parameters required to get the location.

    Get Location Attributes (minimum)

    Get Location Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/locations' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    ["us-east-1"]
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    Mock Service Log REST API

    Take a Log Snapshot of a Mock Service

    To request a log snapshot of a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    The request returns the logId.

    Minimum Parameters for Requesting a Log of a Mock Service

    The following parameters are the base parameters required to request a Log of a Mock Service.

    Request Log of Mock Service Attributes (minimum)

    Request Log of Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/log' \
        -X GET \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d '0'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "log": "string",
        "logId": 0,
        "serviceMockId": 1234,
        "trackingId": "string"
      },
      "skip": 0,
      "total": 0
    }
    


    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    limit

    string

    The Number of results per page.

    Get a Log File of a Mock Service

    To get a log snapshot of a Mock Service either as JSON or a GZIP file, you need to know the Log identifier, your Workspace identifier and the Mock Service identifier. The sample code uses a a logId of 42, a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Requesting a Log File of a Mock Service

    The following parameters are the base parameters required to request a log file of a Mock Service.

    Request Log File of Mock Service Attributes (minimum)

    Request Log File of Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/log/42' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    {}
    


    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    LogId

    integer

    The Log identifier.

    required

    Update the Log Snapshot of a Mock Service

    To update a log snapshot of a Mock Service, you need to know the Log identifier, Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Updating the Log of a Mock Service

    The following parameters are the base parameters required to update the log of a Mock Service.

    Update Log of Mock Service Attributes (minimum)

    Update Log of Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/log/42' \
        -X PUT \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d 'string'
    

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": true,
      "skip": 0,
      "total": 0
    }
    


    Attribute Description
    serviceMockId

    string

    The Mock Service identifier.

    required

    workspaceId

    string

    The Workspace identifier.

    required

    logId

    integer

    The Log identifier.

    required

    log

    string

    The updated Log values.

    required

    Appendix

    This section contains additional details you may find useful as you progress in your use of the BlazeMeter Mock Service API beyond typical use cases.

    Glossary

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

    Location ID

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

    It is found in the response of the following APIs:

    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:

    It is found in the response of the following APIs:

    Mock Service ID

    It is found in the response of the following APIs:

    Mock Service Template ID

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

    It is found in the response of the following APIs:

    Service ID

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

    It is found in the response of the following APIs:

    Tag ID

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

    It is found in the response of the following APIs:

    Taurus UUID

    Transaction ID

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

    It is found in the response of the following APIs:

    Workspace ID

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

    It is found in the response of the following APIs:

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