Get All Ticket - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Ticket","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 all the tickets for the logged in user.**","operationId":"getAllTicket","parameters":[{"description":"To filter by state of ticket use : \u003ccode\u003eState:NEW\u003c/code\u003e. For multiple states \u003ccode\u003eState:NEW,IN_PROGRESS\u003c/code\u003e and/or for free text search, use \u003ccode\u003efts:\u003csearch_string\u003e\u003c/code\u003e","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"Boolean indicating whether to include other users. Requires *review tickets* permission.","in":"query","name":"allUsers","required":false,"schema":{"type":"boolean"}},{"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 https://u32c01p10-vrouter.cisco.com:29059/api/fmc_config/v1/domain/GlobalDomainUUID/changemanagement/tickets ( Success: Test GET ALL method from global domain for Tickets )":{"value":{"items":[{"assignedTo":"admin","description":"tic1","id":"0050568A-1CA8-0ed3-0000-008589934650","metadata":{"creator":"admin","lastUpdateTime":"2022-09-13T12:05Z"},"name":"tic1","status":"ON_HOLD","type":"Ticket"},{"assignedTo":"admin","description":"ssp2","id":"0050568A-1CA8-0ed3-0000-017179869248","metadata":{"creator":"admin","lastUpdateTime":"2022-09-22T03:45Z"},"name":"ssp2","status":"APPROVED","type":"Ticket"},{"assignedTo":"admin","description":"G1","id":"0050568A-1CA8-0ed3-0000-021474836801","metadata":{"creator":"admin","lastUpdateTime":"2022-09-23T06:40Z"},"name":"G1","status":"NEW","type":"Ticket"},{"assignedTo":"admin","description":"G6","id":"0050568A-1CA8-0ed3-0000-021474836914","metadata":{"creator":"admin","lastUpdateTime":"2022-09-23T07:12Z"},"name":"G6","status":"PENDING_APPROVAL","type":"Ticket"},{"assignedTo":"admin","description":"t78","id":"0050568A-1CA8-0ed3-0000-025769803837","metadata":{"creator":"admin","lastUpdateTime":"2022-09-23T07:41Z"},"name":"t78","status":"IN_PROGRESS","type":"Ticket"}],"links":{"self":"https://u32c01p10-vrouter.cisco.com:29059/api/fmc_config/v1/domain/GlobalDomainUUID/changemanagement/tickets?offset=0&limit=25&expanded=true"},"paging":{"count":8,"limit":25,"offset":0,"pages":1}}},"Example 2 : GET https://u32c01p10-vrouter.cisco.com:29059/api/fmc_config/v1/domain/GlobalDomainUUID/changemanagement/tickets ( Success: Test GET ALL method from global domain for Tickets with expanded set to false )":{"value":{"items":[{"id":"0050568A-1CA8-0ed3-0000-008589934650","name":"tic1","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-017179869248","name":"ssp2","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-021474836801","name":"G1","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-021474836914","name":"G6","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-025769803837","name":"t78","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-025769803857","name":"ticket100","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-025769803858","name":"Ticket12","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-025769803859","name":"Ty","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-025769803877","name":"ticp","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-025769803883","name":"Tiwy","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-030064771313","name":"Ticket10923","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-030064771451","name":"admin_427026839854474","type":"Ticket"},{"id":"0050568A-1CA8-0ed3-0000-030064771474","name":"admin_427049519102748","type":"Ticket"}],"links":{"self":"https://u32c01p10-vrouter.cisco.com:29059/api/fmc_config/v1/domain/GlobalDomainUUID/changemanagement/tickets?offset=0&limit=25&expanded=false"},"paging":{"count":13,"limit":25,"offset":0,"pages":1}}},"Example 3 : GET https://u32c01p10-vrouter.cisco.com:29059/api/fmc_config/v1/domain/GlobalDomainUUID/changemanagement/tickets ( Success: Test GET ALL method from global domain for Ticket with history set to true )":{"value":{"assignedTo":"admin","description":"tic1","id":"0050568A-1CA8-0ed3-0000-008589934650","links":{"self":"https://u32c01p10-vrouter.cisco.com:29059/api/fmc_config/v1/domain/GlobalDomainUUID/changemanagement/tickets/ticketuuid?history=true"},"metadata":{"creator":"admin","lastUpdateTime":"2022-09-13T12:05Z"},"name":"tic1","status":"APPROVE","ticketHistory":[{"comment":"approved","state":"APPROVED","time":"2022-09-13T12:05Z","user":"admin"},{"comment":"approved","state":"IN_PROGRESS","time":"2022-09-13T12:05Z","user":"admin"},{"comment":"submit","state":"PENDING_APPROVAL","time":"2022-09-13T12:05Z","user":"admin"},{"comment":"Open to work on the ticket","state":"IN_PROGRESS","time":"2022-09-13T12:04Z","user":"admin"},{"comment":"tic1","state":"NEW","time":"2022-09-13T12:04Z","user":"admin"}],"type":"Ticket"}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Contains the change management ticket data.","properties":{"assignedTo":{"description":"Owner of the ticket","type":"string"},"description":{"type":"string"},"id":{"description":"Unique identifier representing response object","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"},"metadata":{"description":"Contains the metadata properties of the ticket.","type":"object","properties":{"domain":{"type":"object","properties":{"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/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"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/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"description":"User-provided name of the ticket.","type":"string"},"stateChangeDescription":{"type":"string"},"status":{"description":"Ticket status. Possible values are NEW, IN_PROGRESS, PENDING_APPROVAL, APPROVED, REJECTED, DISCARD.","enum":["PENDING_APPROVAL","NEW","APPROVED","DISCARD","IN_PROGRESS","TAKEOVER_TICKET","ON_HOLD","REJECTED"],"type":"string"},"ticketHistory":{"description":"Contains history of the change management ticket.","items":{"type":"object","description":"Contains history of the change management ticket.","properties":{"comment":{"type":"string"},"state":{"description":"State of Ticket.","enum":["PENDING_APPROVAL","NEW","APPROVED","DISCARD","IN_PROGRESS","TAKEOVER_TICKET","ON_HOLD","REJECTED"],"type":"string"},"time":{"description":"The date and time at which the state change occurred.","type":"string"},"user":{"description":"User who initiated state change.","type":"string"}},"$$ref":"#/components/schemas/ITicketHistory"},"type":"array"},"type":{"description":"Type associated with resource: Ticket","type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/Ticket"},"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/TicketListContainer"}}},"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":"getAllTicket","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets"}}