{"type":"api","title":"Handler to get a summary of tasks","meta":{"id":"/apps/pubhub/media/cisco-xdr-api-docs/f4e065ff5977829c89df289df08411f83205f526/08b61137-18a5-31e0-99cb-97776678702a","info":{"title":"REST API.","version":"1.0.0"},"security":[{"oAuth2":["integration:read","private-intel:read","profile:read","inspect:read","users:read","invite:read","enrich:read","oauth:read","response:read","global-intel:read","ao:read","playbook:read"]}],"x-parser-conf":{"serverConfig":"select","overview":{"markdownPath":"reference/automation/overview.md","uri":"automation-api-guide"},"disableAuthEditing":true,"exampleAsDefault":true,"oAuth2":{"clientId":"client-546e34fc-c6bf-4951-ac69-f6d7987a7814","clientSecret":"MYw4_E_tBdFwUwrX6WFYKVD5LQrG2k7XrJ5J046wWE0s1gAKCxJ8VA","proxyEnabled":false},"meta":{"useProxy":true}},"openapi":"3.0.1","servers":[{"url":"https://automate.us.security.cisco.com/{basePath}","variables":{"basePath":{"default":"api"}}}],"securitySchemes":{"oAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://visibility.amp.cisco.com/iroh/oauth2/token","scopes":{"telemetry":"Collect application data for analytics","integration:read":"Manage your modules","private-intel:read":"Access Private Intelligence","admin":"Provide admin privileges","cognitive":"Cognitive Integration","profile:read":"Get your profile information","inspect:read":"Extract Observables and data from text","asset":"Access and modify your assets","event":"Read IROH Events","feedback":"Submit Customer Feedback","sse":"SSE Integration. Manage your Devices.","registry":"Manage registry entries","users:read":"Manage users of your organization","investigation":"Perform threat analysis investigation","invite:read":"Invite users into your organization","casebook":"Access and modify your casebooks","playbook":"Access and modify your playbooks","orbital":"Orbital Integration.","enrich:read":"Query your configured modules for threat intelligence","oauth:read":"Manage OAuth2 Clients","vault":"Grants access to Module Vaults","response:read":"List and execute response actions using configured modules","notification":"Receive notifications from integrations","global-intel:read":"Access AMP Global Intelligence","webhook":"Manage your Webhooks","ao:read":"AO Integration."}}}}}},"spec":{"tags":["Tasks"],"summary":"Handler to get a summary of tasks.","description":"Including total number of tasks, not completed, due soon, overdue, expired and assigned to the user.\nAllowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given task","operationId":"listTaskSummary","responses":{"200":{"description":"An GetTasksSummaryResponse model.\n\n# It will return a summary of tasks","content":{"application/json":{"schema":{"title":"An TasksSummaryResponse model.","type":"object","properties":{"action_required":{"type":"integer","format":"int64","x-go-name":"ActionRequired"},"assigned_to_me":{"type":"integer","format":"int64","x-go-name":"AssignedToMe"},"completed":{"type":"integer","format":"int64","x-go-name":"Completed"},"due_soon":{"type":"integer","format":"int64","x-go-name":"DueSoon"},"expired":{"type":"integer","format":"int64","x-go-name":"Expired"},"overdue":{"type":"integer","format":"int64","x-go-name":"Overdue"},"total":{"type":"integer","format":"int64","x-go-name":"Total"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models","$$ref":"#/components/schemas/TasksSummaryResponse"}}}},"400":{"description":"A Error is a swagger response to represent error","headers":{"code":{"schema":{"type":"integer","format":"int64"}},"description":{"schema":{"type":"string"}},"message":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"A Error is a swagger response to represent error","headers":{"code":{"schema":{"type":"integer","format":"int64"}},"description":{"schema":{"type":"string"}},"message":{"schema":{"type":"string"}}},"content":{}},"500":{"description":"A Error is a swagger response to represent error","headers":{"code":{"schema":{"type":"integer","format":"int64"}},"description":{"schema":{"type":"string"}},"message":{"schema":{"type":"string"}}},"content":{}}},"__originalOperationId":"listTaskSummary","security":[{"oAuth2":["integration:read","private-intel:read","profile:read","inspect:read","users:read","invite:read","enrich:read","oauth:read","response:read","global-intel:read","ao:read","playbook:read"]}],"method":"get","path":"/v1/tasks/summary"}}