ListCasesRequest

2 minute read

Request format for the List Cases method.

Filter

Property Name Data Type Optional Description
created TimeSpan yes Get cases created within the specified time span.
updated TimeSpan yes Get cases updated within the specified time span.
sac string yes Get cases for the specified support access code.
types IncludeCaseTypes or ExcludeCaseTypes yes Get cases of the specified types.
statuses IncludeCaseStatuses or ExcludeCaseStatuses yes Get cases according to the specified case statuses.

TimeSpan

Property Name Data Type Optional Description
before string no Starting date/time of the time span. Format.
after string no Ending date/time of the time span. Format.

IncludeCaseTypes

Property Name Data Type Optional Description
include CaseType (array) no Filter-in the specified case types. Filter out all others. The list of types must not be empty and must contain unique elements.

ExcludeCaseTypes

Property Name Data Type Optional Description
exclude CaseType (array) no Filter-out the specified case types. The list of types must not be empty and must contain unique elements.

CaseType

An open-ended list of case types that are supported in a List Cases filter.

  • Data Type: string
  • Enumeration Elements:
    • Enhancement Request
    • Business Service Request

IncludeCaseStatuses

Property Name Data Type Optional Description
include CaseStatus (array) no Filter-in cases in the specified statuses. Filter out all others. The list of statuses must not be empty and must contain unique elements.

ExcludeCaseStatuses

Property Name Data Type Optional Description
exclude CaseStatus (array) no Filter-out cases in the specified statuses. The list of statuses must not be empty and must contain unique elements.

CaseStatus

An open-ended list of case statuses that are supported in a List Cases filter.

  • Data Type: string
  • Enumeration Elements:
    • In Support
    • Customer Owns Next Steps
    • In Escalation
    • Ready for Deployment
    • In R&D
    • R&D Delivery
    • Pending Closure
    • Closed