Search Tickets

Search tickets.

Notes

  • URLs
    • eg https://api.opsramp.com/api/v2/tenants/clientId/incidents/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=ticket.id&queryString=status:New,Open+priority:High+requester:USR0000000129+startCreationDate:2015-11-10T10:40:20 0000+endCreationDate:2015-11-20T10:40:20 0000
    • eg https://api.opsramp.com/api/v2/tenants/clientId/serviceRequests/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=ticket.id&queryString=status:New,Open+priority:High+requester:USR0000000129+startCreationDate:2015-11-10T10:40:20 0000+endCreationDate:2015-11-20T10:40:20 0000
  • Default time-span is 1 hr when user doesn't specify ticket startCreationDate and endCreationDate
get
/api/v2/tenants/{tenantId}/{ticketEntity}/search

Path Parameters

  • ticketEntitystringrequired

    Supported service desk entity.These are case sensitive.

    Enum:
    incidentsproblemsserviceRequeststimeBoundRequestschangeRequeststasks
  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • uniqueIdstring

    Ticket uuid

  • statusstring

    Current status of ticket.

    Enum:
    NewOpenPendingResolvedClosedOn Hold
  • prioritystring

    Current priority of ticket.

    Enum:
    LowNormalHighUrgentVery Low
  • subjectstring

    A short summary of incident. Example: incident from Alert.

  • startCreationDatestring

    Filter response with request creation date. Provide from date. Example: 2016-03-29T10:15:55 0000 (GMT)

  • endCreationDatestring

    Filter response with request creation date. Provide to date. Example: 2016-03-31T11:20:55 0000 (GMT)

  • extTicketIdstring

    External ticket ID

  • endResolvedDatestring

    Provide to resolved date. Example: 2016-08-14T07:49:59 0000 (GMT)

  • startResolvedDatestring

    Filter tickets with the resolved date. Provide from resolved date. Example: 2016-08-12T06:49:59 0000 (GMT)

  • endClosedDatestring

    Provide to closed date. Example: 2016-08-15T06:54:59 0000 (GMT)

  • startClosedDatestring

    Filter tickets with the closed date. Provide the from closed date. Example: 2016-08-12T06:54:59 0000 (GMT)

  • maxReOpensnumber

    Maximum number of times tickets is reopened. Example: 8

  • minReOpensnumber

    Minimum number of times ticket is reopened. Example: 5

  • maxResolutionTimestring

    Maximum resolution time of tickets. Example: 7200 (time in seconds)

  • minResolutionTimestring

    Minimum resolution time of tickets. Example: 3600 (time in seconds)

  • minResponseTimestring

    Minimum response time of time bound request. Example: 300 (time in seconds)

  • assigneeGroupIdsstring

    ID of the group to which the ticket is assigned. Group uuid

  • endResolutionBreachDatestring

    Provide to date. Example: 2016-09-29T10:40:20 0000 (GMT)

  • startResolutionBreachDatestring

    Filter tickets with resolution breach date. Provide from date. Example: 2016-08-25T08:12:19 0000 (GMT)

  • endResponseBreachDatestring

    Provide to date. Example: 2016-09-28T10:40:20 0000 (GMT)

  • startResponseBreachDatestring

    Filter time bound request with response breach date. Provide from date. Example: 2016-08-25T08:12:19+0000 (GMT)

  • firstContactFixstring

    Problem fixed without assigning to another group.

    Enum:
    truefalse
  • sourcePolicyTypestring

    Source policy type of the ticket. Eg: AUTOINCIDENT

    Enum:
    AUTOINCIDENTINTEGRATION
  • sourcestring

    Source of the time bound request. Eg: PORTAL

    Enum:
    PORTALINTEGRATIONMOBILEEMAIL
  • deviceIdstring

    Unique ID of the device. Example: 481af404-33a6-4d61-af77-c483ca6641fa

  • oldPrioritystring

    Previous priority of ticket request. eg High

    Enum:
    LowNormalHighUrgentVery Low
  • oldStatusstring

    Previous status of ticket request. Eg: Resolved

    Enum:
    NewOpenPendingResolvedOn Hold
  • requesterstring

    User who requests the time bound request. Example: USR0000000129

  • endUpdationDatestring

    Provide the to date. Example: 2016-08-15T10:40:20 0000 (GMT)

  • startUpdationDatestring

    Filter ticket request with the updation date. Example: 2016-08-12T06:54:59 0000 (GMT)

  • assignedTostring

    User who has been assigned ticket. Example: USR0000000129

  • responseBreachstring

    Response to tickets beyond the time limit. Example: false

    Enum:
    falsetrue
  • resolutionBreachstring

    Tickets fixed within the time limit. Example: true

    Enum:
    truefalse
  • maxResponseTimestring

    Maximum response time of time bound request. Example: 600 (time in seconds)

  • includestring

    To include details on customFields, statusFlow while querying for the ticket details.

    Enum:
    customFieldsstatusFlow
00