Dassault Systèmes · Schema

Info

Metadata section of the response providing execution status and result summary.

3DEXPERIENCEPLMProduct Lifecycle ManagementCADManufacturingSolidWorksCATIAENOVIAEngineering3D Collaboration

Properties

Name Type Description
success boolean Indicates whether the API request was executed successfully.
statusCode integer HTTP status code corresponding to the response.
estimatedSearchCount integer Estimated number of results matching the search criteria.
View JSON Schema on GitHub

JSON Schema

info.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/dassault/json-schema/info.json",
  "title": "Info",
  "type": "object",
  "description": "Metadata section of the response providing execution status and result summary.",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Indicates whether the API request was executed successfully."
    },
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code corresponding to the response."
    },
    "estimatedSearchCount": {
      "type": "integer",
      "description": "Estimated number of results matching the search criteria."
    }
  },
  "required": [
    "success",
    "statusCode"
  ]
}