Configuration

Search for test services.

Changed on
get/configure/service

Request

  • Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ${apiUrl}/configure/service
  • Auth: API key in header ITB_API_KEY

Query parameters

domainstring

The domain API key value to identify the domain within which to search for test services. If not provided, the domain used is the one linked to the community identified by the community API key provided for authentication.

keystring

The service's key.

identifierstring

The service's reference identifier. The value is checked in a case-insensitive manner and using wildcard matching.

versionstring

The service's version. The value is checked in a case-insensitive manner and using wildcard matching.

serviceType'messaging' | 'validation' | 'processing'

The service's type.

apiType'soap' | 'rest'

The service's API type.

Response

Test services retrieved.

keystring required

The unique key used to identify the service and its underlying domain parameter.

domainstring required

The API key identifying the domain of the service.

addressstring required

The service's address.

serviceType'messaging' | 'validation' | 'processing' required

The type of the service.

apiType'soap' | 'rest' required

The API type of the service.

descriptionstring

The service's description.

identifierstring

The service's reference identifier.

versionstring

The service's version.

apiKeystring

The API key expected to be included as the ITB-API-KEY HTTP header in callbacks made by this service to the test engine. Only returned if this is enabled at Test Bed level.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

  • 433b3c0ae6d4Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status