Sign in

v1

latestOpenAPI 3.0.12026-07-177473205.1 KB
Configuration

Create a test service.

put/configure/service

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.

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.