{ "info": { "name": "DefProd API", "description": "\n# API Overview\n\nWelcome to the DefProd API documentation. This API provides programmatic access to DefProd's functionality through an HTTP RPC-style interface.\n\n## RPC URL\n\nAll API requests are POST requests made to the single RPC endpoint. The RPC endpoint URL is:\n\n```\nhttps://api.defprod.one/api/v1/rpc\n```\n\nAll requests must have the `Content-Type: application/json` header. The RPC name and any input required are included in the JSON body.\n\n### Example: getUserStory RPC Call\n\nHere's a complete example of making an RPC call to retrieve a user story:\n\n**POST URL:**\n```\nhttps://api.defprod.one/api/v1/rpc\n```\n\n**Request Headers:**\n```\nContent-Type: application/json\nx-api-key: your-api-key-here\n```\n\n**Request Body:**\n```json\n{\n \"name\": \"getUserStory\",\n \"input\": {\n \"userStoryId\": \"USERSTORY-1234\"\n }\n}\n```\n\n### Comparison with REST API\n\nIn contrast to a traditional REST API approach, where you would use different HTTP methods and URL paths for different operations, the RPC-style API uses a single endpoint with the operation specified in the request body.\n\n**REST API approach (not used by DefProd):**\n```\nGET /api/v1/userStory/USERSTORY-1234\n```\n\n**DefProd RPC approach:**\n```\nPOST /api/v1/rpc\n```\n\n**Request Body:**\n```json\n{\n \"name\": \"getUserStory\",\n \"input\": {\n \"userStoryId\": \"USERSTORY-1234\"\n }\n}\n```\n\nThe RPC approach provides several advantages:\n- **Single endpoint**: All operations use the same URL, simplifying routing and firewall configuration\n- **Consistent structure**: All requests follow the same format with `name` and `input` fields\n- **Type safety**: The operation name is explicitly specified in the request body\n- **Extensibility**: New operations can be added without changing URL structures\n\n\n\n## Authentication\n\nAll authenticated RPC calls require an API key to be provided in the request headers.\n\n### API Key Authentication\n\nTo authenticate API requests, include your API key in the `x-api-key` header:\n\n```\nx-api-key: your-api-key-here\n```\n\n### Obtaining an API Key\n\nAPI keys can be created and managed through the user profile section of the application. Each user can create multiple API keys for different purposes.\n\n### Authorization Levels\n\nThe API supports two authorization levels:\n\n- **unauthenticated**: Endpoints that can be accessed without authentication\n- **user**: Endpoints that require a valid user API key\n\n### Security Best Practices\n\n- Keep your API keys secure and never commit them to version control\n- Rotate API keys regularly\n- Use different API keys for different applications or environments\n- Revoke API keys that are no longer needed\n\n\n\n## Request Structure\n\nAll API requests follow a consistent RPC (Remote Procedure Call) structure. Each request is a POST request to a specific endpoint, and the request body contains exactly two fields:\n\n1. **`name`**: A string literal that identifies which RPC operation to execute. This field must match exactly one of the available operation names (e.g., `\"deleteAgent\"`, `\"listArchitectures\"`, etc.).\n\n2. **`input`**: An object containing the parameters for the RPC operation. The structure of this object depends on the specific operation being called. Each operation defines its own input schema, which is documented in the request body schema for that RPC.\n\n### Example Request\n\n```json\n{\n \"name\": \"listArchitectures\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}\n```\n\nThe `name` field determines which RPC operation will be executed, and the `input` object provides the parameters for that operation.\nThe `name` field is required in every request body.\nSome operations may not require an `input` object, in which case the `input` object can be an empty object or left out altogether.\n\n\n\n## Response Format\n\nAll API responses follow a consistent wrapper format that includes metadata about the response and the actual data (if applicable).\n\n### Response Structure\n\nAll successful responses follow one of three formats:\n\n#### Single Data Response\n\nReturns a single object:\n\n```json\n{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"data\": {\n // The actual data object\n }\n}\n```\n\n#### List Data Response\n\nReturns an array of objects with pagination metadata:\n\n```json\n{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\",\n \"filter\": {\n // Applied filters (if any)\n },\n \"sort\": {\n // Applied sorting (if any)\n },\n \"page\": {\n \"number\": 1,\n \"size\": 10\n }\n },\n \"data\": [\n // Array of data objects\n ]\n}\n```\n\n#### No Data Response\n\nReturns only metadata (typically for command operations):\n\n```json\n{\n \"meta\": {\n \"dataCategory\": \"none\",\n \"status\": 200,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n }\n}\n```\n\n### Response Metadata\n\nThe `meta` object contains:\n\n- **dataCategory**: The type of response (`\"single\"`, `\"list\"`, or `\"none\"`)\n- **status**: HTTP status code (typically 200 for success)\n- **timestamp**: ISO 8601 timestamp of when the response was generated\n- **filter** (list only): Applied filter criteria\n- **sort** (list only): Applied sort criteria\n- **page** (list only): Pagination information\n\n### Error Responses\n\nError responses follow a structured format with metadata and error details:\n\n```json\n{\n \"meta\": {\n \"error\": true,\n \"status\": 400,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"error\": {\n \"type\": \"validationError\",\n \"title\": \"Validation Error\",\n \"detail\": \"The request data failed validation\"\n }\n}\n```\n\nSee the Error Responses section for more details on error handling.\n\n\n\n## Error Responses\n\nWhen an API request fails, the response will include error information in a structured format.\n\n### Error Response Structure\n\nAll error responses follow a consistent structure with two main components:\n\n```json\n{\n \"meta\": {\n \"error\": true,\n \"status\": 400,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"error\": {\n \"type\": \"error-type-identifier\",\n \"title\": \"Human-readable error title\",\n \"detail\": \"Detailed error message explaining what went wrong\"\n }\n}\n```\n\n#### Meta Object\n\nThe `meta` object contains:\n- **error**: Always `true` for error responses\n- **status**: HTTP status code (400, 401, 403, 404, 500, etc.)\n- **timestamp**: ISO 8601 timestamp of when the error occurred\n\n#### Error Object\n\nThe `error` object contains:\n- **type**: Error type identifier (AppErrorType) for programmatic error handling\n- **title**: Human-readable error title\n- **detail**: Detailed error message explaining what went wrong\n\n### Common HTTP Status Codes\n\n- **200**: Success\n- **400**: Bad Request - The request was malformed or invalid\n- **401**: Unauthorized - Authentication required or invalid API key\n- **403**: Forbidden - Authenticated but not authorized for this operation\n- **404**: Not Found - The requested resource was not found\n- **500**: Internal Server Error - An unexpected error occurred on the server\n\n### Error Types\n\nThe `error.type` field contains a specific error type identifier (AppErrorType) that can be used for programmatic error handling. Common error types include:\n\n- `validationError`: The request data failed validation (400)\n- `unauthenticatedRequest`: Authentication is required or invalid API key (401)\n- `userNotAuthorized`: The user is not authorized for this operation (403)\n- `resourceNotFound`: The requested resource does not exist (404)\n- `userNotFound`: The user was not found (401)\n- `internalServerError`: An unexpected error occurred on the server (500)\n\n### Example Error Responses\n\n#### 400 Bad Request\n```json\n{\n \"meta\": {\n \"error\": true,\n \"status\": 400,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"error\": {\n \"type\": \"validationError\",\n \"title\": \"Bad Request\",\n \"detail\": \"The request was malformed or invalid\"\n }\n}\n```\n\n#### 401 Unauthorized\n```json\n{\n \"meta\": {\n \"error\": true,\n \"status\": 401,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"error\": {\n \"type\": \"unauthenticatedRequest\",\n \"title\": \"Unauthorized\",\n \"detail\": \"Invalid or missing API key\"\n }\n}\n```\n\n#### 403 Forbidden\n```json\n{\n \"meta\": {\n \"error\": true,\n \"status\": 403,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"error\": {\n \"type\": \"userNotAuthorized\",\n \"title\": \"Forbidden\",\n \"detail\": \"Not authorized for this operation\"\n }\n}\n```\n\n#### 404 Not Found\n```json\n{\n \"meta\": {\n \"error\": true,\n \"status\": 404,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"error\": {\n \"type\": \"resourceNotFound\",\n \"title\": \"Not Found\",\n \"detail\": \"The requested resource was not found\"\n }\n}\n```\n\n#### 500 Internal Server Error\n```json\n{\n \"meta\": {\n \"error\": true,\n \"status\": 500,\n \"timestamp\": \"2024-01-01T00:00:00.000Z\"\n },\n \"error\": {\n \"type\": \"internalServerError\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"An unexpected error occurred on the server\"\n }\n}\n```\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "architecture", "item": [ { "name": "Create Architecture", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new architecture\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createArchitecture\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createArchitecture\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"System Architecture\",\n \"description\": \"Main system architecture\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new architecture\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createArchitecture\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createArchitecture\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"System Architecture\",\n \"description\": \"Main system architecture\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.360Z\"\n },\n \"data\": {\n \"architectureId\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Create Architecture Element", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new architecture element\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createArchitectureElement\",\n \"input\": {\n \"architectureId\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"API Gateway\",\n \"content\": \"Main API gateway component\",\n \"type\": \"component\",\n \"parentId\": \"ARCHITECTURE_ELEMENT-12345678-1234-1234-1234-123456789012\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new architecture element\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createArchitectureElement\",\n \"input\": {\n \"architectureId\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"API Gateway\",\n \"content\": \"Main API gateway component\",\n \"type\": \"component\",\n \"parentId\": \"ARCHITECTURE_ELEMENT-12345678-1234-1234-1234-123456789012\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.360Z\"\n },\n \"data\": {\n \"_id\": \"ARCHITECTURE_ELEMENT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"architectureId\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"API Gateway\",\n \"type\": \"component\",\n \"content\": \"Main API gateway component\",\n \"parentId\": \"ARCHITECTURE_ELEMENT-12345678-1234-1234-1234-123456789012\",\n \"childrenIds\": []\n }\n}" } ] }, { "name": "Delete Architecture", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Delete an architecture\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"deleteArchitecture\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"deleteArchitecture\",\n \"input\": {\n \"architectureId\": \"ARCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Architecture Element", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Delete an architecture element\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"deleteArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"deleteArchitectureElement\",\n \"input\": {\n \"architectureElementId\": \"ARCHITECTURE_ELEMENT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Architecture", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get Architecture operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitecture\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitecture\",\n \"input\": {\n \"architectureId\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get Architecture operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitecture\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitecture\",\n \"input\": {\n \"architectureId\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": {\n \"_id\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"System Architecture\",\n \"description\": \"Main system architecture\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n}" } ] }, { "name": "Get Architecture Element", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get Architecture Element operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitectureElement\",\n \"input\": {\n \"architectureElementId\": \"ARCHELEM-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get Architecture Element operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitectureElement\",\n \"input\": {\n \"architectureElementId\": \"ARCHELEM-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": {\n \"_id\": \"ARCHELEM-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"architectureId\": \"ARCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"API Gateway\",\n \"type\": \"component\",\n \"content\": \"Main API gateway component\",\n \"parentId\": null,\n \"childrenIds\": []\n }\n}" } ] }, { "name": "Get Architecture For Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get the architecture for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitectureForProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitectureForProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get the architecture for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitectureForProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitectureForProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": {\n \"architecture\": {\n \"_id\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"System Architecture\",\n \"description\": \"Main system architecture\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n }\n}" } ] }, { "name": "Get Architecture Tree", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get the architecture tree for an architecture\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitectureTree\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitectureTree\",\n \"input\": {\n \"architectureId\": \"ARCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get the architecture tree for an architecture\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArchitectureTree\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArchitectureTree\",\n \"input\": {\n \"architectureId\": \"ARCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": {\n \"_id\": \"ARCHELEM-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"architectureId\": \"ARCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"Root Element\",\n \"type\": \"component\",\n \"content\": \"Root architecture element\",\n \"parentId\": null,\n \"children\": [\n {\n \"_id\": \"ARCHELEM-e152210e-9d1c-4f46-8b7f-2964161e1d06\",\n \"architectureId\": \"ARCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"createdAt\": \"2025-06-02T08:34:06.140Z\",\n \"name\": \"Frontend\",\n \"parentId\": \"ARCHELEM-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"type\": \"frontend\",\n \"updatedAt\": \"2025-06-04T00:57:33.349Z\",\n \"content\": \"Our chief weapons are components! Components and services... Our two weapons are components and services... and an almost fanatical devotion to RxJS Observables! Our *three* weapons are...\"\n }\n ]\n }\n}" } ] }, { "name": "List Architecture Elements", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List Architecture Elements operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listArchitectureElements\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listArchitectureElements\",\n \"input\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Architectures", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List architectures\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listArchitectures\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listArchitectures\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List architectures\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listArchitectures\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listArchitectures\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": [\n {\n \"_id\": \"ARCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"System Architecture\",\n \"description\": \"Main system architecture\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}" } ] }, { "name": "Move Architecture Element", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Move an architecture element to a new parent and/or position\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"moveArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"moveArchitectureElement\",\n \"input\": {\n \"architectureElementId\": \"ARCHELEM-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"newParentId\": \"ARCHELEM-12345678-1234-1234-1234-123456789012\",\n \"order\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Move an architecture element to a new parent and/or position\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"moveArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"moveArchitectureElement\",\n \"input\": {\n \"architectureElementId\": \"ARCHELEM-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"newParentId\": \"ARCHELEM-12345678-1234-1234-1234-123456789012\",\n \"order\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": {}\n}" } ] }, { "name": "Patch Architecture Element", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to an architecture element\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchArchitectureElement\",\n \"input\": {\n \"architectureElementId\": \"ARCHITECTURE_ELEMENT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Element Name\"\n }\n ],\n \"comment\": \"Update element name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to an architecture element\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchArchitectureElement\",\n \"input\": {\n \"architectureElementId\": \"ARCHITECTURE_ELEMENT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Element Name\"\n }\n ],\n \"comment\": \"Update element name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": {\n \"architectureElementId\": \"ARCHITECTURE_ELEMENT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Element Name\"\n }\n ],\n \"patchId\": \"PATCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Update Architecture", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Update Architecture operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"updateArchitecture\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"updateArchitecture\",\n \"input\": {\n \"architectureId\": \"ARCHITECTURE-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"Updated Architecture Name\",\n \"description\": \"Updated description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Architecture Element", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Update Architecture Element operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"updateArchitectureElement\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"updateArchitectureElement\",\n \"input\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "area", "item": [ { "name": "Create Product Area", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createArea\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"User Management\",\n \"description\": \"Area for managing users\",\n \"displayId\": \"USER\",\n \"order\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createArea\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"User Management\",\n \"description\": \"Area for managing users\",\n \"displayId\": \"USER\",\n \"order\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.361Z\"\n },\n \"data\": {\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Delete Product Area", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Delete a product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"deleteArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"deleteArea\",\n \"input\": {\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Product Area", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArea\",\n \"input\": {\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getArea\",\n \"input\": {\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.362Z\"\n },\n \"data\": {\n \"_id\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"User Management\",\n \"description\": \"Area for managing users\",\n \"displayId\": \"USER\",\n \"order\": 1,\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\",\n \"visibility\": \"public\"\n }\n}" } ] }, { "name": "List All Product Areas", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all product areas\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listAllAreas\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listAllAreas\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all product areas\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listAllAreas\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listAllAreas\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.362Z\"\n },\n \"data\": [\n {\n \"_id\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"User Management\",\n \"description\": \"Area for managing users\",\n \"displayId\": \"USER\",\n \"order\": 1,\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\",\n \"visibility\": \"public\"\n }\n ]\n}" } ] }, { "name": "List Areas", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List areas for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listAreas\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listAreas\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List areas for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listAreas\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listAreas\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.362Z\"\n },\n \"data\": [\n {\n \"_id\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"User Management\",\n \"description\": \"Area for managing users\",\n \"displayId\": \"USER\",\n \"order\": 1,\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\",\n \"visibility\": \"public\"\n }\n ]\n}" } ] }, { "name": "Patch Product Area", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchArea\",\n \"input\": {\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Area Name\"\n }\n ],\n \"comment\": \"Update area name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchArea\",\n \"input\": {\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Area Name\"\n }\n ],\n \"comment\": \"Update area name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.362Z\"\n },\n \"data\": {\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Area Name\"\n }\n ],\n \"patchId\": \"PATCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Reorder Product Areas", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Atomically reorder areas within a product using a database transaction\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"reorderAreas\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"reorderAreas\",\n \"input\": {\n \"productId\": \"PROD-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"from\": 0,\n \"to\": 2\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Product Area", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Update a product area\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"updateArea\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"updateArea\",\n \"input\": {\n \"_id\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"Updated Area Name\",\n \"description\": \"Updated description\",\n \"displayId\": \"USER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "brief", "item": [ { "name": "Create Product Brief", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createBrief\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"description\": \"A new product brief\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createBrief\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"description\": \"A new product brief\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.363Z\"\n },\n \"data\": {\n \"briefId\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Delete Product Brief", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Delete a product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"deleteBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"deleteBrief\",\n \"input\": {\n \"briefId\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Brief For Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get the brief for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getBriefForProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getBriefForProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get the brief for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getBriefForProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getBriefForProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.363Z\"\n },\n \"data\": {\n \"_id\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"description\": \"A product brief\",\n \"userId\": \"USER-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"problem\": {\n \"statement\": \"Problem statement\",\n \"context\": \"Problem context\"\n },\n \"users\": [],\n \"requirements\": [],\n \"aesthetics\": {\n \"style\": \"modern\",\n \"colorScheme\": \"blue\"\n },\n \"successCriteria\": [],\n \"outOfScope\": [],\n \"references\": [],\n \"version\": 1,\n \"history\": [],\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n}" } ] }, { "name": "Get Product Brief", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getBrief\",\n \"input\": {\n \"briefId\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getBrief\",\n \"input\": {\n \"briefId\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.363Z\"\n },\n \"data\": {\n \"_id\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"description\": \"A product brief\",\n \"userId\": \"USER-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"problem\": {\n \"statement\": \"Problem statement\",\n \"context\": \"Problem context\"\n },\n \"users\": [],\n \"requirements\": [],\n \"aesthetics\": {\n \"style\": \"modern\",\n \"colorScheme\": \"blue\"\n },\n \"successCriteria\": [],\n \"outOfScope\": [],\n \"references\": [],\n \"version\": 1,\n \"history\": [],\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n}" } ] }, { "name": "List All Product Briefs", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all product briefs\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listBriefs\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listBriefs\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all product briefs\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listBriefs\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listBriefs\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.363Z\"\n },\n \"data\": [\n {\n \"_id\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"description\": \"A product brief\",\n \"userId\": \"USER-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"problem\": {\n \"statement\": \"Problem statement\",\n \"context\": \"Problem context\"\n },\n \"users\": [],\n \"requirements\": [],\n \"aesthetics\": {\n \"style\": \"modern\",\n \"colorScheme\": \"blue\"\n },\n \"successCriteria\": [],\n \"outOfScope\": [],\n \"references\": [],\n \"version\": 1,\n \"history\": [],\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}" } ] }, { "name": "Patch Product Brief", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchBrief\",\n \"input\": {\n \"briefId\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/description\",\n \"value\": \"Updated brief description\"\n }\n ],\n \"comment\": \"Update brief description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchBrief\",\n \"input\": {\n \"briefId\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/description\",\n \"value\": \"Updated brief description\"\n }\n ],\n \"comment\": \"Update brief description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.363Z\"\n },\n \"data\": {\n \"briefId\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/description\",\n \"value\": \"Updated brief description\"\n }\n ],\n \"patchId\": \"PATCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Update Product Brief", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Update a product brief\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"updateBrief\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"updateBrief\",\n \"input\": {\n \"_id\": \"BRIEF-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"description\": \"Updated brief description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "documentation", "item": [ { "name": "Get API Info", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get API Info operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getApiInfo\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getApiInfo\",\n \"input\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get API Info operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getApiInfo\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getApiInfo\",\n \"input\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.363Z\"\n },\n \"data\": {\n \"name\": \"DefProd API\",\n \"version\": \"1\"\n }\n}" } ] } ] }, { "name": "product", "item": [ { "name": "Create Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new product definition\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createProduct\",\n \"input\": {\n \"name\": \"My New Product\",\n \"description\": \"A sample product description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new product definition\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createProduct\",\n \"input\": {\n \"name\": \"My New Product\",\n \"description\": \"A sample product description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.363Z\"\n },\n \"data\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Delete Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Delete a product definition\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"deleteProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"deleteProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Export Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Export a product and all associated data as JSON\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"exportProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"exportProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Export a product and all associated data as JSON\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"exportProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"exportProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.364Z\"\n },\n \"data\": {\n \"_id\": \"PRODUCT:1\",\n \"product\": {\n \"_id\": \"PRODUCT:1\",\n \"name\": \"My Product\",\n \"description\": \"A sample product description\"\n },\n \"brief\": {\n \"_id\": \"BRIEF:1\",\n \"productId\": \"PRODUCT:1\",\n \"description\": \"Product brief description\"\n },\n \"areas\": [],\n \"userStories\": [],\n \"architecture\": null,\n \"architectureElements\": [],\n \"genaiSession\": null\n }\n}" } ] }, { "name": "Get Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a product definition\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a product definition\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.364Z\"\n },\n \"data\": {\n \"_id\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"My Product\",\n \"description\": \"A sample product\",\n \"userId\": \"USER-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n}" } ] }, { "name": "Import Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Import a product and all associated data from exported JSON\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"importProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"importProduct\",\n \"input\": {\n \"product\": {\n \"_id\": \"PRODUCT-old-id\",\n \"name\": \"My Product\",\n \"userId\": \"USER-old-id\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n },\n \"brief\": null,\n \"area\": [],\n \"userStory\": [],\n \"architecture\": null,\n \"architectureElement\": [],\n \"genaiSession\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Import a product and all associated data from exported JSON\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"importProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"importProduct\",\n \"input\": {\n \"product\": {\n \"_id\": \"PRODUCT-old-id\",\n \"name\": \"My Product\",\n \"userId\": \"USER-old-id\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n },\n \"brief\": null,\n \"area\": [],\n \"userStory\": [],\n \"architecture\": null,\n \"architectureElement\": [],\n \"genaiSession\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.364Z\"\n },\n \"data\": {\n \"productId\": \"PRODUCT-new-id\"\n }\n}" } ] }, { "name": "List Product Summaries", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List Product Summaries operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listProductSummaries\"`." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List Product Summaries operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listProductSummaries\"`." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.364Z\"\n },\n \"data\": [\n {\n \"_id\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"My Product\",\n \"description\": \"A sample product\",\n \"userId\": \"USER-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\",\n \"progressPercent\": 75,\n \"briefStatus\": \"complete\",\n \"userStoriesCount\": 10,\n \"userStoriesTotal\": 15,\n \"areasCount\": 3,\n \"architectureStatus\": \"partial\",\n \"lastActivityAt\": \"2024-01-15T00:00:00Z\",\n \"recentActivity\": \"Updated user stories\"\n }\n ]\n}" } ] }, { "name": "List Products", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all product definitions\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listProducts\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listProducts\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all product definitions\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listProducts\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listProducts\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.364Z\"\n },\n \"data\": [\n {\n \"_id\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"My Product\",\n \"description\": \"A sample product\",\n \"userId\": \"USER-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}" } ] }, { "name": "Patch Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a product definition\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Product Name\"\n }\n ],\n \"comment\": \"Update product name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a product definition\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchProduct\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Product Name\"\n }\n ],\n \"comment\": \"Update product name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.365Z\"\n },\n \"data\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Product Name\"\n }\n ],\n \"patchId\": \"PATCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Update Product", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Update Product operation\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"updateProduct\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"updateProduct\",\n \"input\": {\n \"_id\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"name\": \"Updated Product Name\",\n \"status\": \"active\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "userStory", "item": [ { "name": "Create User Story", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createUserStory\",\n \"input\": {\n \"title\": \"User Story Title\",\n \"description\": \"User story description\",\n \"displayId\": \"US-001\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"status\": \"todo\",\n \"priority\": \"medium\",\n \"acceptanceCriteria\": [\n \"Criterion 1\",\n \"Criterion 2\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Create a new user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"createUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"createUserStory\",\n \"input\": {\n \"title\": \"User Story Title\",\n \"description\": \"User story description\",\n \"displayId\": \"US-001\",\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"status\": \"todo\",\n \"priority\": \"medium\",\n \"acceptanceCriteria\": [\n \"Criterion 1\",\n \"Criterion 2\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.365Z\"\n },\n \"data\": {\n \"userStoryId\": \"USER_STORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Delete User Story", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Delete a user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"deleteUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"deleteUserStory\",\n \"input\": {\n \"userStoryId\": \"USERSTORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get User Story", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getUserStory\",\n \"input\": {\n \"userStoryId\": \"USERSTORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Get a user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"getUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"getUserStory\",\n \"input\": {\n \"userStoryId\": \"USERSTORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.365Z\"\n },\n \"data\": {\n \"_id\": \"USERSTORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"title\": \"User can log in\",\n \"description\": \"As a user, I want to log in so that I can access my account\",\n \"priority\": \"high\",\n \"status\": \"todo\",\n \"storyPoints\": 5,\n \"displayId\": \"US-001\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\"\n }\n}" } ] }, { "name": "List All User Stories", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all user stories\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listAllUserStories\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listAllUserStories\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List all user stories\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listAllUserStories\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listAllUserStories\",\n \"input\": {\n \"page\": 1,\n \"pageSize\": 10\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.365Z\"\n },\n \"data\": [\n {\n \"_id\": \"STORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"title\": \"User can log in\",\n \"description\": \"As a user, I want to log in so that I can access my account\",\n \"priority\": \"high\",\n \"status\": \"todo\",\n \"storyPoints\": 5,\n \"displayId\": \"US-001\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\"\n }\n ]\n}" } ] }, { "name": "List User Stories", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List user stories for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listUserStories\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listUserStories\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "List user stories for a product\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"listUserStories\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"listUserStories\",\n \"input\": {\n \"productId\": \"PRODUCT-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"list\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.365Z\"\n },\n \"data\": [\n {\n \"_id\": \"USERSTORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"title\": \"User can log in\",\n \"description\": \"As a user, I want to log in so that I can access my account\",\n \"priority\": \"high\",\n \"status\": \"todo\",\n \"storyPoints\": 5,\n \"displayId\": \"US-001\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\"\n }\n ]\n}" } ] }, { "name": "Patch User Story", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchUserStory\",\n \"input\": {\n \"userStoryId\": \"USER_STORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Story Name\"\n }\n ],\n \"comment\": \"Update story name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Apply patch changes to a user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"patchUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"patchUserStory\",\n \"input\": {\n \"userStoryId\": \"USER_STORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Story Name\"\n }\n ],\n \"comment\": \"Update story name\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"dataCategory\": \"single\",\n \"status\": 200,\n \"timestamp\": \"2025-12-12T11:45:23.365Z\"\n },\n \"data\": {\n \"userStoryId\": \"USER_STORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"patch\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"Updated Story Name\"\n }\n ],\n \"patchId\": \"PATCH-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\"\n }\n}" } ] }, { "name": "Reorder User Stories", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Atomically reorder user stories within an area using a database transaction\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"reorderUserStories\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"reorderUserStories\",\n \"input\": {\n \"productId\": \"PROD-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"areaId\": \"AREA-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"from\": 0,\n \"to\": 2\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update User Story", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{rpcUrl}}/rpc", "host": [ "{{rpcUrl}}" ], "path": [ "rpc" ] }, "description": "Update an existing user story\n\n**Note:** Call `POST /rpc` with the `name` field set to `\"updateUserStory\"`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"updateUserStory\",\n \"input\": {\n \"userStoryId\": \"USER_STORY-f97658ab-4af4-420a-a1a3-2f2b3ae70bdb\",\n \"displayId\": \"US-001\",\n \"name\": \"Updated Story Name\",\n \"description\": \"Updated description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] } ], "variable": [ { "key": "rpcUrl", "value": "http://localhost:8200/api/v1", "type": "string" }, { "key": "apiKey", "value": "your-api-key-here", "type": "string" } ] }