UiPath · JSON Structure

Test Manager Create Requirement Request Structure

Request payload for creating a new requirement

Type: object Properties: 3 Required: 1
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

CreateRequirementRequest is a JSON Structure definition published by UiPath, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name description externalId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-structure/test-manager-create-requirement-request-structure.json",
  "name": "CreateRequirementRequest",
  "description": "Request payload for creating a new requirement",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the new requirement",
      "maxLength": 512,
      "example": "Example Name"
    },
    "description": {
      "type": "string",
      "description": "Detailed description of the requirement specification",
      "example": "Example description for this resource."
    },
    "externalId": {
      "type": "string",
      "description": "Optional external identifier for integration with third-party tools",
      "example": "abc123"
    }
  }
}