Interface StoredSessionsApi


  • public interface StoredSessionsApi
    • Method Detail

      • deleteStoredSession

        @DELETE("api/v2/sessions/{sessionid}")
        retrofit2.Call<Void> deleteStoredSession​(@Path("sessionid")
                                                 String sessionid)
        Delete individual stored session Delete a stored session.
        Parameters:
        sessionid - Unique session id (required)
        Returns:
        Call<Void>
      • getStoredSession

        @Headers("Accept: application/octet-stream")
        @GET("api/v2/sessions/{sessionid}")
        @Streaming
        retrofit2.Call<okhttp3.ResponseBody> getStoredSession​(@Path("sessionid")
                                                              String sessionid,
                                                              @Query("removeconfidentialstrings")
                                                              Boolean removeconfidentialstrings,
                                                              @Query("timeframestart")
                                                              String timeframestart,
                                                              @Query("timeframeend")
                                                              String timeframeend)
        Export stored session Export a stored session. For large stored sessions the size of the downloaded file can be huge. Make sure the download machine has enough free space to ensure that the download is successful.
        Parameters:
        sessionid - Unique session id (required)
        removeconfidentialstrings - true to remove confidential strings from the exported session, false to keep them included (optional, default to true)
        timeframestart - Timeframe filter start time timestamp (ISO8601) (optional)
        timeframeend - Timeframe filter end time timestamp (ISO8601) (optional)
        Returns:
        Call<Void>
      • getStoredSessionMetaData

        @GET("api/v2/sessions/{sessionid}/metadata")
        retrofit2.Call<SessionMetadata> getStoredSessionMetaData​(@Path("sessionid")
                                                                 String sessionid)
        Get session metadata Get comprehensive details of a stored session. For more information look at the response entity.
        Parameters:
        sessionid - Unique session id (required)
        Returns:
        Call<SessionMetadata>
      • listStoredSessions

        @GET("api/v2/sessions")
        retrofit2.Call<Sessions> listStoredSessions()
        List stored sessions Get a list of all stored sessions which are available to the current user.
        Returns:
        Call<Sessions>