Configuration

Create a test service.

Changed on
put/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

Request body

keystring required

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

addressstring required

The service's address as an absolute HTTP URL.

descriptionstring

The service's description.

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

The type of the service.

apiType'soap' | 'rest'

The API type of the service.

authBasicUsernamestring

When HTTP basic authentication is used, this is the username to use.

authBasicPasswordstring

When HTTP basic authentication is used, this is the password to use.

authTokenUsernamestring

When the WS-Security UsernameToken profile is used, this is the username to use.

authTokenPasswordstring

When the WS-Security UsernameToken profile is used, this is the password to use.

authTokenPasswordType'digest' | 'text'

When the WS-Security UsernameToken profile is used, this is the type of password provision to use.

authHttpHeaderNamestring

When authentication via HTTP header is used, this is the name of the header.

authHttpHeaderValuestring

When authentication via HTTP header is used, this is the value of the header.

identifierstring

The service's reference identifier.

versionstring

The service's version.

domainstring

The API key identifying the domain of the service. This is required if the community API key used for authentication refers to a community that is not linked to a specific domain.

replaceExistingboolean

In case the service information matches an existing domain parameter, this flag can be used to link the parameter with the service's definition.

Response

Test service created. The response body is only present if API keys are enabled for test engine callbacks, in which case it carries the API key assigned to the new service.

apiKeystring required

The API key value.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the 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 non-success response with the status

  • 433b3c0ae6d4Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • 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