ServiceListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-ofbiz/refs/heads/main/json-schema/apache-ofbiz-service-list-response-schema.json",
  "title": "ServiceListResponse",
  "description": "API response containing a list of exported services.",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code.",
      "example": 200
    },
    "statusDescription": {
      "type": "string",
      "description": "Human-readable status description.",
      "example": "OK"
    },
    "successMessage": {
      "type": "string",
      "description": "Success message.",
      "example": "OK"
    },
    "data": {
      "type": "array",
      "description": "Array of exported service entries.",
      "items": {
        "type": "object",
        "description": "A single exported OFBiz service with its metadata and invocation link.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The service name.",
            "example": "findProductById"
          },
          "description": {
            "type": "string",
            "description": "Human-readable description of the service.",
            "example": "Finds productId(s) corresponding to a product reference."
          },
          "link": {
            "type": "object",
            "description": "Hypermedia link to a service endpoint.",
            "properties": {
              "href": {
                "type": "string",
                "format": "uri",
                "description": "URL to invoke the service.",
                "example": "https://localhost:8443/rest/services/findProductById"
              },
              "rel": {
                "type": "string",
                "description": "Relationship type.",
                "example": "self"
              },
              "type": {
                "type": "string",
                "description": "HTTP method for accessing the service.",
                "example": "get"
              }
            }
          }
        }
      }
    }
  }
}