DevOpsAgentService / Client / get_backlog_task

get_backlog_task¶

DevOpsAgentService.Client.get_backlog_task(**kwargs)¶

Gets a backlog task for the specified agent space and task id

Request Syntax

response = client.get_backlog_task(
    agentSpaceId='string',
    taskId='string'
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier for the agent space containing the task
taskId (string) –
[REQUIRED]

The unique identifier of the task to retrieve

Return type:

dict

Returns:

Response Syntax

{
    'task': {
        'agentSpaceId': 'string',
        'taskId': 'string',
        'executionId': 'string',
        'title': 'string',
        'description': 'string',
        'reference': {
            'system': 'string',
            'title': 'string',
            'referenceId': 'string',
            'referenceUrl': 'string',
            'associationId': 'string'
        },
        'taskType': 'INVESTIGATION'|'EVALUATION',
        'priority': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
        'status': 'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'version': 123,
        'supportMetadata': {...}|[...]|123|123.4|'string'|True|None,
        'metadata': {...}|[...]|123|123.4|'string'|True|None,
        'primaryTaskId': 'string',
        'statusReason': 'string',
        'hasLinkedTasks': True|False
    }
}

Response Structure

(dict) –

Response structure containing the requested backlog task
- task (dict) –
  
  The requested task object
  - agentSpaceId (string) –
    
    The unique identifier for the agent space containing this task
  - taskId (string) –
    
    The unique identifier for this task
  - executionId (string) –
    
    The execution ID associated with this task, if any
  - title (string) –
    
    The title of the task
  - description (string) –
    
    Optional detailed description of the task
  - reference (dict) –
    
    Optional reference information linking this task to external systems
    - system (string) –
      
      The name of the external system
    - title (string) –
      
      Optional title for the reference
    - referenceId (string) –
      
      The unique identifier in the external system
    - referenceUrl (string) –
      
      URL to access the reference in the external system
    - associationId (string) –
      
      Association identifier of the external system
  - taskType (string) –
    
    The type of this task
  - priority (string) –
    
    The priority level of this task
  - status (string) –
    
    The current status of this task
  - createdAt (datetime) –
    
    Timestamp when this task was created
  - updatedAt (datetime) –
    
    Timestamp when this task was last updated
  - version (integer) –
    
    Version number for optimistic locking
  - supportMetadata (document) –
    
    Optional support metadata for the task
  - metadata (document) –
    
    Optional metadata for the task
  - primaryTaskId (string) –
    
    The task ID of the primary investigation this task is linked to
  - statusReason (string) –
    
    Explanation for why the task status was changed (e.g., linked reason)
  - hasLinkedTasks (boolean) –
    
    Indicates if this task has other tasks linked to it

Exceptions

DevOpsAgentService.Client.exceptions.ValidationException
DevOpsAgentService.Client.exceptions.ContentSizeExceededException
DevOpsAgentService.Client.exceptions.ServiceQuotaExceededException
DevOpsAgentService.Client.exceptions.ConflictException
DevOpsAgentService.Client.exceptions.InternalServerException
DevOpsAgentService.Client.exceptions.AccessDeniedException
DevOpsAgentService.Client.exceptions.ResourceNotFoundException
DevOpsAgentService.Client.exceptions.ThrottlingException
DevOpsAgentService.Client.exceptions.InvalidParameterException