{"type":"api","title":"Handler to get all workflows","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":["Workflows"],"summary":"Handler to get all workflows.","description":"Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow\nMandatory Query Param: limit -\u003e Non Negative limit.","operationId":"getAllWorkflowsPostQueryParamsV1Dot2","parameters":[{"name":"is_atomic","in":"query","description":"Provide true to return only atomic workflows and false for non atomic. Skip to return all workflows.","schema":{"type":"boolean","x-go-name":"IsAtomic"},"x-go-name":"IsAtomic"},{"name":"search","in":"query","description":"Comma separated list of search terms to filter based on workflow names","schema":{"type":"string","x-go-name":"Search"},"x-go-name":"Search"},{"name":"state","in":"query","description":"Comma separated list of workflow states to filter","schema":{"type":"string","x-go-name":"State"},"x-go-name":"State"},{"name":"limit","in":"query","description":"Number of workflows to return for this request","required":true,"schema":{"type":"integer","format":"int64","x-go-name":"Limit"},"x-go-name":"Limit"},{"name":"start","in":"query","description":"Return list of workflows from n'th workflow, n is start to be provided","schema":{"type":"integer","format":"int64","x-go-name":"Start"},"x-go-name":"Start"},{"name":"sort_by","in":"query","description":"Return list of workflows in sorted order, supported values are 'updated_on' and 'atomic_group'","schema":{"type":"string","x-go-name":"SortBy"},"x-go-name":"SortBy"}],"requestBody":{"description":"An request body to submit.","content":{"application/json":{"schema":{"title":"WorkflowsPostRequest ...","type":"object","properties":{"categories":{"type":"array","description":"list of categories to get for.\nin: body","items":{"type":"string"},"x-go-name":"Categories"},"exclude_rule_types":{"type":"array","description":"flag to be used in conjunction with rule_types. specify rule_types to be excluded.\n\"none\" if workflows should have atleast 1 rule_type\nallowed values: none, schedule.rule_schedule, amqp.rule_event, email.rule_event, approval_task.rule_event,\nwebhook.rule_event, kafka.rule_event, incident.rule_event, playbook_assignment.rule_event\nin: body","items":{"type":"string"},"x-go-name":"ExcludeRuleTypes"},"owner":{"type":"array","description":"list of owner IDs to filter by\nin: body","items":{"type":"string"},"x-go-name":"Owner"},"rule_types":{"type":"array","description":"list of rule_types to filter by. \"none\" if workflows with no rule_type needed\nallowed values: none, schedule.rule_schedule, amqp.rule_event, email.rule_event, approval_task.rule_event,\nwebhook.rule_event, kafka.rule_event, incident.rule_event, playbook_assignment.rule_event\nin: body","items":{"type":"string"},"x-go-name":"RuleTypes"},"wf_metadata":{"title":"WorkflowMetaData ...","required":["coa"],"type":"object","properties":{"coa":{"title":"WorkflowMetaData ...","required":["observable_types"],"type":"object","properties":{"actuator":{"type":"string","description":"Actuator.\nin: body","x-go-name":"Actuator"},"observable_types":{"type":"array","description":"list of observable types to get for.\nin: body","items":{"type":"string"},"x-go-name":"ObservableTypes"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/CourseOfAction"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models","$$ref":"#/components/schemas/WorkflowMetaData"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models","$$ref":"#/components/schemas/WorkflowsPostRequest"}}},"required":false,"x-go-name":"RequestBody"},"responses":{"200":{"description":"An WorkflowResponse response model\n\n# This is used for returning a response with a single workflow as a body","content":{"application/json":{"schema":{"type":"object","properties":{"_links":{"type":"object","properties":{"next":{"type":"string","x-go-name":"Next"},"prev":{"type":"string","x-go-name":"Prev"},"self":{"type":"string","x-go-name":"Self"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models","$$ref":"#/components/schemas/PaginationLink"},"results":{"type":"array","items":{"title":"WorkflowDefinitionGetAllResponse ...","type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"categories":{"type":"array","items":{"type":"string"},"x-go-name":"Categories"},"created_by":{"type":"string","x-go-name":"CreatedBy"},"created_on":{"type":"string","format":"date-time","x-go-name":"CreatedOn"},"description":{"type":"string","x-go-name":"Description"},"id":{"type":"string","x-go-name":"DefinitionID"},"metadata":{"type":"object","properties":{"coa":{"title":"WorkflowMetaData ...","required":["observable_types"],"type":"object","properties":{"actuator":{"type":"string","description":"Actuator.\nin: body","x-go-name":"Actuator"},"observable_types":{"type":"array","description":"list of observable types to get for.\nin: body","items":{"type":"string"},"x-go-name":"ObservableTypes"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/CourseOfAction"},"flags":{"type":"array","items":{"type":"string"},"x-go-name":"Flags"},"git_info":{"type":"object","properties":{"commit_hash":{"type":"string","x-go-name":"CommitHash"},"commit_message":{"type":"string","x-go-name":"CommitMessage"},"commited_by":{"type":"string","x-go-name":"CommitedBy"},"commited_on":{"type":"string","format":"date-time","x-go-name":"CommitedOn"},"file_name":{"type":"string","x-go-name":"FileName"},"target_id":{"type":"string","x-go-name":"TargetID"}},"description":"nolint: misspell\nGitInfo maintains information about the last Git Import","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/GitInfo"},"lock":{"type":"object","properties":{"locked":{"type":"boolean","x-go-name":"Locked"},"locked_by":{"type":"string","x-go-name":"LockedBy"},"message":{"type":"string","x-go-name":"Message"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/WorkflowLock"}},"description":"WorkflowMetadata maintains miscellaneous metadata for the workflow","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/WorkflowMetadata"},"name":{"type":"string","x-go-name":"Name"},"owner":{"type":"string","x-go-name":"Owner"},"permissions":{"type":"array","items":{"type":"string"},"x-go-name":"Permissions"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"schema_id":{"type":"string","x-go-name":"ViewSchemaID"},"started_on":{"type":"string","format":"date-time","x-go-name":"LastInstStartedOn"},"status":{"title":"Status ...","type":"object","properties":{"details":{"type":"object","properties":{"code":{"type":"string","x-go-name":"Code"},"description":{"type":"string","x-go-name":"Description"},"message":{"type":"string","x-go-name":"Message"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/StatusDetails"},"prev_state":{"type":"string","description":"DefinitionState","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/State"},"state":{"type":"string","description":"DefinitionState","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/State"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/Status"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"},"updated_by":{"type":"string","x-go-name":"UpdatedBy"},"updated_on":{"type":"string","format":"date-time","x-go-name":"UpdatedOn"},"valid":{"type":"boolean","x-go-name":"Valid"},"workflow_valid":{"type":"boolean","x-go-name":"WorkflowValid"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models","$$ref":"#/components/schemas/WorkflowDefinitionGetAllResponse"},"x-go-name":"Results"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models","$$ref":"#/components/schemas/WorkflowGetAllPaginationResponse"}}}},"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":{}},"401":{"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":{}},"404":{"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":{}}},"x-codegen-request-body-name":"request_body","__originalOperationId":"getAllWorkflowsPostQueryParamsV1Dot2","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":"post","path":"/v1.2/workflows"}}