XChangeResponse - Cisco XDR APIs

{"type":"model","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":{"type":"object","properties":{"response_summary":{"title":"ResponseSummary ...","type":"object","properties":{"count":{"type":"integer","format":"int64","x-go-name":"Count"},"created":{"type":"integer","format":"uint32","x-go-name":"Created"},"deleted":{"type":"integer","format":"uint32","x-go-name":"Deleted"},"has_object":{"type":"boolean","x-go-name":"HasObject"},"ids":{"type":"array","items":{"type":"string"},"x-go-name":"IDs"},"retrieved":{"type":"integer","format":"uint32","x-go-name":"Retrieved"},"runningCount":{"type":"integer","format":"int64","x-go-name":"RunningCount"},"updated":{"type":"integer","format":"uint32","x-go-name":"Updated"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/ResponseSummary"},"xchange":{"title":"IXChange ...","type":"object","properties":{"GetAuthoredBy":{"type":"string","description":"GetAuthoredBy ..."},"GetBaseType":{"type":"string","description":"GetBaseType ..."},"GetBlurb":{"type":"string","description":"GetBlurb ..."},"GetCategories":{"type":"array","description":"GetCategories ...","items":{"type":"string"}},"GetContactEmail":{"type":"string","description":"GetContactEmail ..."},"GetCreatedBy":{"type":"string","description":"GetCreatedBy ..."},"GetCreatedOn":{"type":"string","description":"GetCreatedOn ...","format":"date-time"},"GetDataSchemaID":{"type":"string","description":"GetDataSchemaID ..."},"GetDocumentID":{"type":"string","description":"GetDocumentID returns xchange id"},"GetExternalLinks":{"type":"array","description":"GetExternalLinks ...","items":{"type":"object","properties":{"key":{"type":"string","x-go-name":"Title"},"value":{"type":"string","x-go-name":"URL"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/ExternalLinks"}},"GetImage":{"type":"string","description":"GetImage ..."},"GetInstallInfo":{"title":"InstallInfo ...","type":"object","properties":{"installed_time":{"type":"string","format":"date-time","x-go-name":"InstalledTime"},"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"},"version":{"type":"string","x-go-name":"InstalledVersion"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/InstallInfo"},"GetInstalledCount":{"type":"integer","description":"GetInstalledCount ...","format":"uint32"},"GetLatestVersion":{"type":"string","description":"GetLatestVersion ..."},"GetName":{"type":"string","description":"GetName ..."},"GetObjectType":{"title":"LHObjType generated on 2024-06-14T11:01:04+05:30. DO NOT EDIT.","type":"string","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/mdb-maps/entity","$$ref":"#/components/schemas/LHObjType"},"GetOwner":{"type":"string","description":"GetOwner ..."},"GetPath":{"type":"string","description":"GetPath ..."},"GetProperties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"description":"GetProperties ..."},"GetPublishedVersions":{"type":"object","additionalProperties":{"type":"string"},"description":"GetPublishedVersions ..."},"GetPublisherInfo":{"type":"object","properties":{"published_by":{"type":"string","x-go-name":"PublishedBy"},"published_version":{"type":"string","x-go-name":"PublishedVersion"},"publisher_tenant_id":{"type":"string","x-go-name":"PublisherTenantID"},"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"}},"description":"PublisherInfo applicable for only global xchange tenant","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/PublisherInfo"},"GetRating":{"type":"object","properties":{"avg_rating":{"type":"number","format":"double","x-go-name":"AverageRating"},"rating_updated_on":{"type":"string","format":"date-time","x-go-name":"RatingUpdatedOn"},"total_no_of_ratings":{"type":"integer","format":"uint32","x-go-name":"TotalNoOfRatings"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/RatingInfo"},"GetReleaseNote":{"type":"string","description":"GetReleaseNote gets the release note"},"GetRev":{"type":"integer","description":"GetRev ...","format":"int64"},"GetState":{"type":"string","description":"DefinitionState","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/State"},"GetStatus":{"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"},"GetSubmitInfo":{"title":"SubmitInfo ...","type":"object","properties":{"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"},"submitted_for_review_version":{"type":"string","x-go-name":"SubmittedVersion"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/SubmitInfo"},"GetTenantID":{"type":"string","description":"GetTenantID ..."},"GetTitle":{"type":"string","description":"GetTitle ..."},"GetType":{"type":"string","description":"GetType ..."},"GetTypeOfSubmission":{"type":"string","description":"GetTypeOfSubmission ..."},"GetUniqueName":{"type":"string","description":"GetUniqueName ..."},"GetUpdatedBy":{"type":"string","description":"GetUpdatedBy ..."},"GetUpdatedOn":{"type":"string","description":"GetUpdatedOn ...","format":"date-time"},"GetViewSchemaID":{"type":"string","description":"GetViewSchemaID ..."},"GetXChangeID":{"type":"string","description":"GetXChangeID ..."},"ObjType":{"type":"string","description":"ObjType ..."}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/IXChange"},"xchange_metadata":{"type":"object","properties":{"_rev":{"type":"integer","format":"int64","x-go-name":"Rev"},"created_by":{"type":"string","x-go-name":"CreatedBy"},"created_on":{"type":"string","format":"date-time","x-go-name":"CreatedOn"},"module_targets":{"type":"array","items":{"type":"object","properties":{"external_id":{"type":"string","x-go-name":"ExternalID"},"module_type":{"type":"string","x-go-name":"ModuleType"},"target_id":{"type":"string","x-go-name":"TargetID"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeModuleTargetMetadata"},"x-go-name":"ModuleTargets"},"object_type":{"title":"LHObjType generated on 2024-06-14T11:01:04+05:30. DO NOT EDIT.","type":"string","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/mdb-maps/entity","$$ref":"#/components/schemas/LHObjType"},"rules":{"type":"object","additionalProperties":{"type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"description":{"type":"string","x-go-name":"Description"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeRuleMetadata"},"x-go-name":"Rules"},"runtime_users":{"type":"object","additionalProperties":{"type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"blurb":{"type":"string","x-go-name":"Blurb"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeRUMetadata"},"x-go-name":"RuntimeUsers"},"target_groups":{"type":"object","additionalProperties":{"type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"blurb":{"type":"string","x-go-name":"Blurb"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"targets":{"type":"array","items":{"title":"TargetGroupProperties represents the specific target group attributes information\nIt holds the data/view schema id of targettype, target Ids and criteria for Target group","type":"object","properties":{"criteria":{"type":"array","items":{"title":"Expression ....","type":"object","properties":{"left_operand":{"type":"object","properties":{},"x-go-name":"LeftOperand"},"operator":{"type":"string","x-go-name":"Operator"},"right_operand":{"type":"object","properties":{},"x-go-name":"RightOperand"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/base-microservice/longhornparser/models","$$ref":"#/components/schemas/Expression"},"x-go-name":"Criteria"},"data_target_type":{"type":"string","x-go-name":"DataTargetType"},"include_all_targets":{"type":"boolean","x-go-name":"IncludeAllTargets"},"matched_target_ids":{"type":"array","items":{"type":"string"},"x-go-name":"MatchedTargetIDs"},"selected_target_ids":{"type":"array","items":{"type":"string"},"x-go-name":"SelectedTargetIDs"},"view_target_type":{"type":"string","x-go-name":"ViewTargetType"}},"description":"nolint:lll","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/TargetGroupProperties"},"x-go-name":"Targets"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeTargetGroupMetadata"},"x-go-name":"TargetGroups"},"targets":{"type":"object","additionalProperties":{"type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"blurb":{"type":"string","x-go-name":"Blurb"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeTargetMetadata"},"x-go-name":"Targets"},"tenant_id":{"type":"string","x-go-name":"TenantID"},"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"},"variables":{"type":"object","additionalProperties":{"type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"blurb":{"type":"string","x-go-name":"Blurb"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeGlobalVariableMetadata"},"x-go-name":"Variables"},"wf_variables":{"type":"object","additionalProperties":{"type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"blurb":{"type":"string","x-go-name":"Blurb"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"},"workflow_id":{"type":"string","x-go-name":"WorkflowID"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeWFVariableMetadata"},"x-go-name":"WFVariables"},"workflows":{"type":"object","additionalProperties":{"type":"object","properties":{"atomic_workflows":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XChangeWFMetaData","$$ref":"#/components/schemas/XChangeWFMetaData"},"x-go-name":"AtomicWorkflows"},"blurb":{"type":"string","x-go-name":"Blurb"},"published_version":{"type":"string","x-go-name":"PublishedVersion"},"sub_workflows":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XChangeWFMetaData","$$ref":"#/components/schemas/XChangeWFMetaData"},"x-go-name":"SubWorkflows"},"title":{"type":"string","x-go-name":"Title"},"unique_name":{"type":"string","x-go-name":"UniqueName"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeWFMetaData"},"x-go-name":"Workflows"},"xchange_categories":{"type":"object","additionalProperties":{"type":"object","properties":{"base_type":{"type":"string","x-go-name":"BaseType"},"description":{"type":"string","x-go-name":"Description"},"name":{"type":"string","x-go-name":"Name"},"object_type":{"title":"LHObjType generated on 2024-06-14T11:01:04+05:30. DO NOT EDIT.","type":"string","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/mdb-maps/entity","$$ref":"#/components/schemas/LHObjType"},"title":{"type":"string","x-go-name":"Title"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeCategoryMetadata"},"x-go-name":"XChangeCategories"},"xchange_id":{"type":"string","x-go-name":"XChangeID"},"xchange_metadata_id":{"type":"string","x-go-name":"XChangeMDID"}},"description":"nolint:lll","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/XChangeMetaData"}},"description":"XChangeResponse object for XChange CRUD calls","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","title":"XChangeResponse"}}