Handler returning information about action's instance - Cisco XDR APIs

{"type":"api","title":"Handler returning information about action's instance","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":["WorkflowInstances"],"summary":"Handler returning information about action's instance.","description":"Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow","operationId":"getWFActionInstanceById","parameters":[{"name":"wf_instance_id","in":"path","description":"The Id of worklfow instance","required":true,"schema":{"type":"string","x-go-name":"WFInstanceID"},"x-go-name":"WFInstanceID"},{"name":"action_instance_id","in":"path","description":"The Id of worklfow action instance","required":true,"schema":{"type":"string","x-go-name":"WFActionInstanceID"},"x-go-name":"WFActionInstanceID"},{"name":"iteration","in":"query","description":"Iteration number for block instance if it has blocks","schema":{"type":"integer","format":"uint64","x-go-name":"Iteration"},"x-go-name":"Iteration"}],"responses":{"200":{"description":"An WorkflowActionInstanceResponse response model\n\n# This is used for returning a response of action instance as body","content":{"application/json":{"schema":{"title":"ActionInstanceGetResponse ...","type":"object","properties":{"actions":{"type":"array","items":{"title":"ActionInstanceGetAllResponse ...","type":"object","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/ActionInstanceGetAllResponse","$$ref":"#/components/schemas/ActionInstanceGetAllResponse"},"x-go-name":"Actions"},"adapter_id":{"type":"string","x-go-name":"AdapterID"},"base_type":{"type":"string","x-go-name":"BaseType"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/ActionInstanceGetAllResponse","$$ref":"#/components/schemas/ActionInstanceGetAllResponse"},"x-go-name":"Branches"},"blocks_count":{"type":"integer","format":"int64","x-go-name":"BranchesCount"},"definition_id":{"type":"string","x-go-name":"DefinitionID"},"id":{"type":"string","x-go-name":"InstanceID"},"name":{"type":"string","x-go-name":"Name"},"schema_id":{"type":"string","x-go-name":"ViewSchemaID"},"skip_execution":{"type":"boolean","x-go-name":"SkipExecution"},"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"},"subworkflow_id":{"type":"string","x-go-name":"SubWorkflowID"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"version":{"type":"string","x-go-name":"Version"},"workflow_id":{"type":"string","x-go-name":"WorkflowID"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models","$$ref":"#/components/schemas/ActionInstanceGetAllResponse"},"x-go-name":"Actions"},"adapter_id":{"type":"string","x-go-name":"AdapterID"},"base_type":{"type":"string","x-go-name":"BaseType"},"blocks":{"type":"array","items":{"title":"ActionInstanceGetAllResponse ...","type":"object","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/ActionInstanceGetAllResponse","$$ref":"#/components/schemas/ActionInstanceGetAllResponse"},"x-go-name":"Actions"},"adapter_id":{"type":"string","x-go-name":"AdapterID"},"base_type":{"type":"string","x-go-name":"BaseType"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/ActionInstanceGetAllResponse","$$ref":"#/components/schemas/ActionInstanceGetAllResponse"},"x-go-name":"Branches"},"blocks_count":{"type":"integer","format":"int64","x-go-name":"BranchesCount"},"definition_id":{"type":"string","x-go-name":"DefinitionID"},"id":{"type":"string","x-go-name":"InstanceID"},"name":{"type":"string","x-go-name":"Name"},"schema_id":{"type":"string","x-go-name":"ViewSchemaID"},"skip_execution":{"type":"boolean","x-go-name":"SkipExecution"},"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"},"subworkflow_id":{"type":"string","x-go-name":"SubWorkflowID"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"version":{"type":"string","x-go-name":"Version"},"workflow_id":{"type":"string","x-go-name":"WorkflowID"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models","$$ref":"#/components/schemas/ActionInstanceGetAllResponse"},"x-go-name":"Branches"},"definition_id":{"type":"string","x-go-name":"DefinitionID"},"description":{"type":"string","x-go-name":"Description"},"ended_on":{"type":"string","format":"date-time","x-go-name":"EndedOn"},"id":{"type":"string","x-go-name":"InstanceID"},"name":{"type":"string","x-go-name":"Name"},"output":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Output"},"output_schema":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"OutputSchema"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"property_schema":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"PropertySchema"},"schema_id":{"type":"string","x-go-name":"ViewSchemaID"},"skip_execution":{"type":"boolean","x-go-name":"SkipExecution"},"started_by":{"type":"string","x-go-name":"StartedBy"},"started_on":{"type":"string","format":"date-time","x-go-name":"StartedOn"},"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"},"ui_config":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"UIConfig"},"version":{"type":"string","x-go-name":"Version"},"workflow_id":{"type":"string","x-go-name":"WorkflowID"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models","$$ref":"#/components/schemas/ActionInstanceGetResponse"}}}},"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":{}},"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":{}}},"__originalOperationId":"getWFActionInstanceById","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/instances/{wf_instance_id}/actions/{action_instance_id}"}}