add get_question_details() method

SeaBlooms · SeaBlooms · commit 84fe38929f9b · 2025-08-14T19:17:10.000-06:00
diff --git a/examples/08_questions_management.py b/examples/08_questions_management.py
@@ -352,6 +352,91 @@ def list_questions_example(j1):
     except Exception as e:
         print(f"Error listing questions: {e}")
 
+def get_question_details_example(j1):
+    """Demonstrate getting specific question details."""
+    
+    print("=== Get Question Details Example ===\n")
+    
+    print("First, let's get a list of questions to find one to examine:")
+    try:
+        questions = j1.list_questions()
+        
+        if questions:
+            # Get details of the first question
+            first_question = questions[0]
+            question_id = first_question['id']
+            question_title = first_question['title']
+            
+            print(f"Getting detailed information for question: {question_title}")
+            print(f"Question ID: {question_id}")
+            
+            # Get full question details
+            question_details = j1.get_question_details(question_id=question_id)
+            
+            print(f"\nDetailed Question Information:")
+            print(f"  Title: {question_details['title']}")
+            print(f"  ID: {question_details['id']}")
+            print(f"  Source ID: {question_details.get('sourceId', 'Not specified')}")
+            print(f"  Description: {question_details.get('description', 'No description')}")
+            print(f"  Tags: {', '.join(question_details.get('tags', []))}")
+            print(f"  Last Updated: {question_details.get('lastUpdatedTimestamp', 'Not specified')}")
+            print(f"  Account ID: {question_details.get('accountId', 'Not specified')}")
+            print(f"  Show Trend: {question_details.get('showTrend', False)}")
+            print(f"  Polling Interval: {question_details.get('pollingInterval', 'Not set')}")
+            
+            # Display queries
+            queries = question_details.get('queries', [])
+            print(f"\n  Queries ({len(queries)}):")
+            for i, query in enumerate(queries):
+                print(f"    Query {i+1}: {query.get('name', 'Unnamed')}")
+                print(f"      - Query: {query.get('query', 'No query')}")
+                print(f"      - Version: {query.get('version', 'Not specified')}")
+                print(f"      - Results Are: {query.get('resultsAre', 'Not specified')}")
+            
+            # Display compliance information
+            compliance = question_details.get('compliance')
+            if compliance:
+                print(f"\n  Compliance Information:")
+                if isinstance(compliance, dict):
+                    print(f"    Standard: {compliance.get('standard', 'Not specified')}")
+                    requirements = compliance.get('requirements', [])
+                    if requirements:
+                        print(f"    Requirements: {', '.join(map(str, requirements))}")
+                    controls = compliance.get('controls', [])
+                    if controls:
+                        print(f"    Controls: {', '.join(map(str, controls))}")
+                else:
+                    print(f"    Compliance data type: {type(compliance)}")
+                    print(f"    Compliance content: {compliance}")
+            else:
+                print(f"\n  Compliance Information: None")
+            
+            # Display variables
+            variables = question_details.get('variables', [])
+            if variables:
+                print(f"\n  Variables ({len(variables)}):")
+                for var in variables:
+                    print(f"    - Name: {var.get('name', 'Unnamed')}")
+                    print(f"      Required: {var.get('required', False)}")
+                    print(f"      Default: {var.get('default', 'None')}")
+            else:
+                print(f"\n  Variables: None")
+                
+            # Display integration information
+            integration_def_id = question_details.get('integrationDefinitionId')
+            if integration_def_id:
+                print(f"\n  Integration Definition ID: {integration_def_id}")
+            else:
+                print(f"\n  Integration Definition ID: None")
+                
+        else:
+            print("No questions found in the account to examine")
+            
+    except Exception as e:
+        print(f"Error getting question details: {e}")
+        print(f"Error type: {type(e).__name__}")
+        print(f"Error details: {str(e)}")
+
 def question_use_cases(j1):
     """Demonstrate real-world use cases for questions."""
     
@@ -430,6 +515,9 @@ def main():
     time.sleep(1)
     
     list_questions_example(j1)
+    time.sleep(1)
+
+    get_question_details_example(j1)
     
     question_use_cases(j1)
     
diff --git a/examples/README.md b/examples/README.md
@@ -128,6 +128,7 @@ This directory contains comprehensive examples demonstrating how to use the Jupi
 **Key Methods Demonstrated**:
 - `create_question()` - Create questions with J1QL queries
 - `list_questions()` - List all questions in the account
+- `get_question_details()` - Get detailed information for a specific question by ID
 
 ### 9. **examples.py**
 **Purpose**: Comprehensive examples of all major SDK methods
@@ -141,6 +142,7 @@ This directory contains comprehensive examples demonstrating how to use the Jupi
 **Key Methods Demonstrated**:
 - All major SDK methods including:
 - `list_questions()` - List and analyze all questions in the account
+- `get_question_details()` - Get detailed information for specific questions
 - `create_question()` - Create questions with various configurations
 - Entity lifecycle management methods
 - Relationship management methods
@@ -301,6 +303,14 @@ security_compliance = j1.list_questions(
     tags=["security", "compliance"]
 )
 
+# Get detailed information for a specific question
+question_details = j1.get_question_details(
+    question_id="f90f9aa1-f9ff-47f7-ab34-ce8fa11c7add"
+)
+print(f"Question title: {question_details['title']}")
+print(f"Compliance standard: {question_details.get('compliance', {}).get('standard')}")
+print(f"Number of queries: {len(question_details.get('queries', []))}")
+
 # Analyze by compliance standards
 compliance_standards = {}
 for question in questions:
diff --git a/examples/examples.py b/examples/examples.py
@@ -649,4 +649,41 @@
     polling_questions = [q for q in list_questions_r if 'pollingInterval' in q and q['pollingInterval'] and q['pollingInterval'] != 'DISABLED']
     print(f"  Questions with polling enabled: {len(polling_questions)}")
 
+# get_question_details - get specific question details
+print("\nget_question_details() - Get specific question:")
+if list_questions_r:
+    # Get details of the first question
+    first_question_id = list_questions_r[0]['id']
+    try:
+        question_details = j1.get_question_details(question_id=first_question_id)
+        print(f"  Retrieved details for question: {question_details['title']}")
+        print(f"  Question ID: {question_details['id']}")
+        print(f"  Description: {question_details.get('description', 'No description')}")
+        print(f"  Tags: {question_details.get('tags', [])}")
+        print(f"  Number of queries: {len(question_details.get('queries', []))}")
+        print(f"  Show trend: {question_details.get('showTrend', False)}")
+        print(f"  Polling interval: {question_details.get('pollingInterval', 'Not set')}")
+        
+        # Show compliance details if available
+        if question_details.get('compliance'):
+            compliance = question_details['compliance']
+            if isinstance(compliance, dict):
+                print(f"  Compliance standard: {compliance.get('standard', 'Not specified')}")
+                if 'requirements' in compliance:
+                    reqs = compliance['requirements']
+                    if isinstance(reqs, list):
+                        print(f"  Compliance requirements: {', '.join(map(str, reqs))}")
+        
+        # Show variables if available
+        if question_details.get('variables'):
+            variables = question_details['variables']
+            print(f"  Variables: {len(variables)}")
+            for var in variables:
+                print(f"    - {var.get('name', 'Unnamed')}: required={var.get('required', False)}, default={var.get('default', 'None')}")
+                
+    except Exception as e:
+        print(f"  Error getting question details: {e}")
+else:
+    print("  No questions available to get details for")
+
 print()
diff --git a/jupiterone/client.py b/jupiterone/client.py
@@ -43,6 +43,7 @@
     UPDATE_RULE_INSTANCE,
     EVALUATE_RULE_INSTANCE,
     QUESTIONS,
+    GET_QUESTION,
     CREATE_QUESTION,
     COMPLIANCE_FRAMEWORK_ITEM,
     LIST_COLLECTION_RESULTS,
@@ -1318,6 +1319,33 @@ def list_questions(self, search_query: str = None, tags: List[str] = None):
 
         return results
 
+    def get_question_details(self, question_id: str = None):
+        """Get details of a specific question by ID
+        
+        Args:
+            question_id (str): The unique ID of the question to retrieve
+            
+        Returns:
+            Dict: The question object with all its details
+            
+        Example:
+            question_details = j1_client.get_question_details(
+                question_id="f90f9aa1-f9ff-47f7-ab34-ce8fa11c7add"
+            )
+            
+        Raises:
+            ValueError: If question_id is not provided
+            JupiterOneApiError: If the question is not found or other API errors occur
+        """
+        if not question_id:
+            raise ValueError("question_id is required")
+            
+        variables = {"id": question_id}
+        
+        response = self._execute_query(GET_QUESTION, variables=variables)
+        
+        return response["data"]["question"]
+
     def create_question(
         self,
         title: str,
diff --git a/jupiterone/constants.py b/jupiterone/constants.py
@@ -920,6 +920,48 @@
       __typename
     }
 """
+
+GET_QUESTION = """
+    query question($id: ID!) {
+      question(id: $id) {
+        ...QuestionFields
+        __typename
+      }
+    }
+
+    fragment QuestionFields on Question {
+      id
+      sourceId
+      title
+      description
+      tags
+      lastUpdatedTimestamp
+      queries {
+        name
+        query
+        version
+        resultsAre
+        __typename
+      }
+      compliance {
+        standard
+        requirements
+        controls
+        __typename
+      }
+      variables {
+        name
+        required
+        default
+        __typename
+      }
+      accountId
+      integrationDefinitionId
+      showTrend
+      pollingInterval
+      __typename
+    }
+"""
 CREATE_QUESTION = """
     mutation CreateQuestion($question: CreateQuestionInput!) {
         createQuestion(question: $question) {
diff --git a/tests/test_list_questions.py b/tests/test_list_questions.py
