List Cases by filter API endpoint

[Michael_Schepp]

Hi all, I'm trying to make use of the "List Cases by filter" API endpoint ( https://api.siemplify.co/#392b3a6a-533e-4e5c-8d6b-1f1d42828faf ) for searching cases in a specific time period (e.g. last 24h). It's easy to filter based on the Title and so on, but I'm not able to filter with startTime/endTime or timeOffset. Anybody has a hint for me, how to specify the corresponding values exactly?

[JoshShomo]

@Michael_Schepp I went through the same struggle. I found the time format is startTime: 2022-02-03T00:00:00.000Z , and I had to include timeRangeFilter: 0 in the request payload

[JoshShomo]

so a sample payload for 24 hours of cases would be
{'startTime': '2022-02-02T01:05:38.055Z', 'endTime': '2022-02-03T01:05:38.055Z', 'timeRangeFilter': 0}

[Michael_Schepp]

thank you very much @JoshShomo This worked out well, besides the fact, that the parameter 'timeRangeFilter' is nowhere mentioed in the API...
@Tomtomfridman

[Michael_Schepp]

@Tomtomfridman is there anywhere an more actual version of the API documentation than https://api.siemplify.co/ which is still based only on v5.5.3 ?

[Michael_Schepp]

@JoshShomo Do you also know a way to filter for caseIds with //api/external/v1/search/CaseSearchEverything ?
This doesn't seem to work either and //api/external/v1/search/CaseSearchEverythingByIds unfortunately returns wrong results

[JoshShomo]

yeah if you’re using //api/external/v1/search/CaseSearchEverything try
{"title": "Caseids:34534,34533"}

[JoshShomo]

Also if you’re curious for how Siemplify actually uses the API, from the Search tab you can open up the network tab in your browser debug tools. I use firefox, so I just right click, inspect, switch to the network tool. Anyways, whenever you change search parameters like tags, environments, time, under the hood it makes a call to //api/external/v1/search/CaseSearchEverything . I took a lot of inspiration from their api usage here

[JoshShomo]

And when I say “Search tab”, i mean the https://[yoursiemplifyhost]/#/main/search

[Tomtomfridman]

Hi @Michael_Schepp
There is no additional documentation at this point, but you can find the API that is available at version linked to your server by looking here:
https:// insert your server address here /swagger

[Michael_Schepp]

Thanks @JoshShomo and @Tomtomfridman !