NEnetxms
Web Service Definitions

Get web service definition details

Changed on

Retrieve details of a specific web service definition.

get/v1/web-service-definitions/{definition-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/web-service-definitions/{definition-id}
  • Auth
    HTTP bearer

Path parameters

definition-idinteger required

Web service definition ID

Response

Web service definition details retrieved successfully

idinteger

Web service definition ID

guidstring

Web service definition GUID

namestring

Definition name

descriptionstring

Definition description

urlstring

Web service URL (may contain %1, %2, etc. for parameter substitution)

httpRequestMethodinteger

HTTP request method (0=GET, 1=POST, 2=PUT, 3=DELETE, 4=PATCH)

requestDatastring

Request body data

flagsinteger

Flags (bit mask: 1=verify certificate, 2=verify host, 4=force plain text parser, 8=follow location)

authTypeinteger

Authentication type (0=none, 1=basic, 2=digest, 3=NTLM, 4=bearer, 5=any)

loginstring

Login name or token

passwordstring

Password

cacheRetentionTimeinteger

Cache retention time in milliseconds

requestTimeoutinteger

Request timeout in milliseconds

Changes