Versions Compared

Version Old Version 7 New Version 8
Changes made by

Mario Mann

Mario Mann

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview - Business Context RESTful Service

Service
Description
Get all business context instancesThis service returns information of all existing business context instances.
Get one business context instanceThis service returns information on existing business context instances (application).
Get all business transactions of an applicationThis service returns all business transactions of an application.
Get detailed information of a business transaction and applicationThis service returns detailed information of a business transaction and application.

Overview - Business Context Definition RESTful Service

Service
Description
Get all business context definitionsThis service returns information of all existing business context definition.
Get detailed information of one business context definitionThis service returns information on existing business context definition (application definition)

Get information of all business transaction definitions of an application

This service returns all business transactions of an application
Get detailed information of one business transaction definition and applicationThis service returns detailed information of a business transaction and application

1. Get all business context instances
Anchor
bcall
bcall

...

Path:/rest/bc/app/{id}/btx/{businessTxId}
Parameters:
  1. id (int value, required) - Id of the application to get.

  2. businessTxId (int value, required) - Id of the business transaction to get.

Example URI:/rest/bc/app/-1133255037/btx/463443944
Example output:


Code Block
{
  "id": 463443944,
  "businessTransactionDefinitionId": 58868659,
  "name": "actionPerformMethod"
}



...

1. Get all business context definitions
Anchor
bcdall
bcdall

Path:/rest/bc/definition/app
Example URI:/rest/bc/definition/app
Example output:


Code Block
[
  {
    "id": -1866447452,
    "applicationName": "Calculator",
    "description": null,
    "matchingRuleExpression": {
      "@type": "OR",
      "operands": [
        {
          "@type": "StringMatching",
          "matchingType": "EQUALS",
          "snippet": "127.0.0.1",
          "stringValueSource": {
            "@class": "rocks.inspectit.shared.cs.ci.business.valuesource.impl.HostValueSource"
          },
          "searchNodeInTrace": false,
          "maxSearchDepth": -1
        }
      ]
    }
  },
  {
    "id": 1952140054,
    "applicationName": "TestApp",
    "description": null,
    "matchingRuleExpression": {
      "@type": "OR",
      "operands": [
        {
          "@type": "StringMatching",
          "matchingType": "CONTAINS",
          "snippet": "test",
          "stringValueSource": {
            "@class": "rocks.inspectit.shared.cs.ci.business.valuesource.impl.HttpUriValueSource"
          },
          "searchNodeInTrace": false,
          "maxSearchDepth": -1
        },
        {
          "@type": "NOT",
          "operand": {
            "@type": "StringMatching",
            "matchingType": "EQUALS",
            "snippet": "my.method()",
            "stringValueSource": {
              "@class": "rocks.inspectit.shared.cs.ci.business.valuesource.impl.MethodSignatureValueSource"
            },
            "searchNodeInTrace": true,
            "maxSearchDepth": -1
          }
        }
      ]
    }
  }
]



2. Get detailed information of one business context definition
Anchor
bcddetailed
bcddetailed

Path:/rest/bc/definition/app/{id}
Parameters:
  1. id (int value, required) - Id of the application to get.
Example URI:/rest/bc/definition/app/1952140054
Example output:


Code Block
{
  "id": 1952140054,
  "applicationName": "TestApp",
  "description": null,
  "matchingRuleExpression": {
    "@type": "OR",
    "operands": [
      {
        "@type": "StringMatching",
        "matchingType": "CONTAINS",
        "snippet": "test",
        "stringValueSource": {
          "@class": "rocks.inspectit.shared.cs.ci.business.valuesource.impl.HttpUriValueSource"
        },
        "searchNodeInTrace": false,
        "maxSearchDepth": -1
      },
      {
        "@type": "NOT",
        "operand": {
          "@type": "StringMatching",
          "matchingType": "EQUALS",
          "snippet": "my.method()",
          "stringValueSource": {
            "@class": "rocks.inspectit.shared.cs.ci.business.valuesource.impl.MethodSignatureValueSource"
          },
          "searchNodeInTrace": true,
          "maxSearchDepth": -1
        }
      }
    ]
  }
}



3. Get information of all business transaction definitions of an application
Anchor
bcdallapp
bcdallapp

Path:/rest/bc/definition/app/{id}/btx
Parameters:
  1. id (int value, required) - Id of the application to get.
Example URI:/rest/bc/definition/app/1952140054/btx
Example output:


Code Block
[
  {
    "id": 0,
    "businessTransactionDefinitionName": "Unknown Transaction",
    "nameExtractionExpression": null,
    "description": null,
    "matchingRuleExpression": {
      "@type": "Boolean",
      "value": true
    },
    "changeable": false
  }
]


4. Get detailed information of one business transaction definition and application
Anchor
bcdappdetailedd
bcdappdetailedd

Path:/rest/bc/definition/app/{id}/btx/{businessTxId}
Parameters:
  1. id (int value, required) - Id of the application to get.

  2. businessTxId (int value, required) - Id of the business transaction to get.

Example URI:/rest/bc/definition/app/1952140054/btx/0
Example output:


Code Block
{
  "id": 0,
  "businessTransactionDefinitionName": "Unknown Transaction",
  "nameExtractionExpression": null,
  "description": null,
  "matchingRuleExpression": {
    "@type": "Boolean",
    "value": true
  },
  "changeable": false
}