Get Ticket Preview Change - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Ticket Preview Change","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get ticket-based changes.**","operationId":"getTicketPreviewChange","parameters":[{"description":"The filter criteria for which the details have to be fetched - Only works when \"expanded\" is set to \"true\". Examples: ParentEntityTypes:AccessPolicy, EntityUUID:0050568C-35A0-0ed3-0000-004294969351.","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/workflow/tickets/ContainerUUID/previewchanges?limit=1 ( Get all paginated ticker preview change objects with limit=1 )":{"value":{"items":[{"action":"string","entityName":"string","entityType":"string","entityUUID":"string","id":"string","impactedDevices":"List\u003cIImpactedDevice\u003e","lastUpdatedByUsers":"List\u003cstring\u003e","links":{"self":"https://\u003cIP:PORT\u003e/api/fmc_config/v1/domain/{domainUUID}/workflow/tickets/{containerUUID}/previewchanges"},"message":"string","name":"string","parentUUID":"string","referencesAdded":"List\u003cIReferenceUpdate\u003e","referencesDeleted":"List\u003cIReferenceUpdate\u003e","type":"TicketPreviewChange","valueAdded":"List\u003cIValueAdd\u003e","valueDeleted":"List\u003cIValueDelete\u003e","valueUpdated":"List\u003cIValueUpdate\u003e"}],"links":{"self":"https://\u003cIP:PORT\u003e/api/fmc_config/v1/domain/{domainUUID}/workflow/tickets/{containerUUID}/previewchanges?limit=1"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","properties":{"action":{"enum":["ADD","DELETE","UPDATE","NOCHANGE"],"type":"string"},"activityID":{"type":"string"},"entityName":{"type":"string"},"entityType":{"type":"string"},"entityUUID":{"type":"string"},"impactedDevices":{"items":{"type":"object","properties":{"action":{"enum":["ADD","DELETE","UPDATE","NOCHANGE"],"type":"string"},"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IImpactedDevice"},"type":"array"},"lastUpdatedByUsers":{"items":{"type":"string"},"type":"array"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"message":{"type":"string"},"parentUUID":{"type":"string"},"referencesAdded":{"items":{"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"type":"string"},"fieldName":{"type":"string"}},"$$ref":"#/components/schemas/IReferenceUpdate"},"type":"array"},"referencesDeleted":{"items":{"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"type":"string"},"fieldName":{"type":"string"}},"$$ref":"#/components/schemas/IReferenceUpdate"},"type":"array"},"valueAdded":{"items":{"type":"object","properties":{"fieldName":{"type":"string"},"newValue":{"type":"string"}},"$$ref":"#/components/schemas/IValueAdd"},"type":"array"},"valueDeleted":{"items":{"type":"object","properties":{"fieldName":{"type":"string"},"oldValue":{"type":"string"}},"$$ref":"#/components/schemas/IValueDelete"},"type":"array"},"valueUpdated":{"items":{"type":"object","properties":{"fieldName":{"type":"string"},"newValue":{"type":"string"},"oldValue":{"type":"string"}},"$$ref":"#/components/schemas/IValueUpdate"},"type":"array"},"version":{"type":"string"}},"$$ref":"#/components/schemas/TicketPreviewChange"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/TicketPreviewChangeListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Change Management"],"__originalOperationId":"getTicketPreviewChange","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets/{containerUUID}/previewchanges"}}