Interface PhilterService

public interface PhilterService

Retrofit definition of Philter's HTTP API (version 4.0.0).

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<String>	compilePolicy(String text)
retrofit2.Call<GenericResponse>	createContext(String name, Boolean entityTypeDisambiguation, Boolean ledger)
retrofit2.Call<LegalHoldResponse>	createHold(String owner, LegalHoldRequest request)
retrofit2.Call<GenericResponse>	createRedactList(String owner, String json)
retrofit2.Call<GenericResponse>	deleteContext(String name)
retrofit2.Call<GenericResponse>	deleteContextEntries(String name)
retrofit2.Call<GenericResponse>	deleteContextEntry(String name, String entryId)
retrofit2.Call<Void>	deleteDocument(String documentId, String owner)
retrofit2.Call<Void>	deleteHold(String reference, String owner)
retrofit2.Call<Void>	deleteList(String list, String owner)
retrofit2.Call<Void>	deletePolicy(String policyName, String owner)
retrofit2.Call<ExplainResponse>	explain(String context, String policyName, String filename, String text)
retrofit2.Call<String>	exportContextEntries(String name, String owner)
retrofit2.Call<String>	exportLedger(String documentId, String owner)
retrofit2.Call<String>	filter(String context, String policyName, String filename, Boolean async, String text)
retrofit2.Call<okhttp3.ResponseBody>	filter(String context, String policyName, String filename, Boolean async, okhttp3.RequestBody bytes)
retrofit2.Call<String>	getContext(String name)
retrofit2.Call<String>	getContextEntries(String name, Integer offset, Integer limit)
retrofit2.Call<String>	getContexts(String owner, Integer offset, Integer limit)
retrofit2.Call<okhttp3.ResponseBody>	getDocument(String documentId, String owner)
retrofit2.Call<String>	getDocuments(String owner, Integer offset, Integer limit)
retrofit2.Call<String>	getDocumentStatus(String documentId, String owner)
retrofit2.Call<LegalHoldResponse>	getHold(String reference, String owner)
retrofit2.Call<List<LegalHoldResponse>>	getHolds(String owner, Integer offset, Integer limit)
retrofit2.Call<String>	getLedger(String query, String owner, Integer offset, Integer limit)
retrofit2.Call<String>	getLedgerEntry(String documentId, String owner)
retrofit2.Call<GetListsResponse>	getList(String name, String owner)
retrofit2.Call<String>	getLists(String owner)
retrofit2.Call<List<String>>	getPolicies(String owner, Integer offset, Integer limit)
retrofit2.Call<String>	getPolicy(String policyName, String owner)
retrofit2.Call<String>	getPolicyDiff(String policyName, int from, int to, String owner)
retrofit2.Call<String>	getPolicyVersion(String policyName, int revision, String owner)
retrofit2.Call<List<PolicyVersionSummary>>	getPolicyVersions(String policyName, String owner, Integer offset, Integer limit)
retrofit2.Call<String>	getRedactLists(String owner)
retrofit2.Call<StatusResponse>	health()
retrofit2.Call<String>	importContextEntries(String name, String onConflict, String owner, String json)
retrofit2.Call<String>	isLedgerValid(String documentId, String owner)
retrofit2.Call<String>	reidentify(String owner, ReidentifyRequest request)
retrofit2.Call<PolicyRollbackResponse>	rollbackPolicy(String policyName, int revision, String owner)
retrofit2.Call<GenericResponse>	saveList(String list, String description, String owner, List<String> values)
retrofit2.Call<Void>	savePolicy(String name, String owner, String json)
retrofit2.Call<String>	signingKey()
retrofit2.Call<StatusResponse>	status()
retrofit2.Call<GenericResponse>	updateContext(String name, Boolean entityTypeDisambiguation, Boolean ledger)
retrofit2.Call<GenericResponse>	updateRedactList(String owner, String json)

Method Details

filter

@Headers({"Accept: text/plain","Content-Type: text/plain"})
@POST("/api/filter")
retrofit2.Call<String> filter(@Query("c")
 String context,
 @Query("p")
 String policyName,
 @Query("filename")
 String filename,
 @Query("async")
 Boolean async,
 @Body
 String text)

filter

@Streaming
@Headers({"Accept: application/zip","Content-Type: application/pdf"})
@POST("/api/filter")
retrofit2.Call<okhttp3.ResponseBody> filter(@Query("c")
 String context,
 @Query("p")
 String policyName,
 @Query("filename")
 String filename,
 @Query("async")
 Boolean async,
 @Body
 okhttp3.RequestBody bytes)

explain

@Headers({"Accept: application/json","Content-Type: text/plain"})
@POST("/api/explain")
retrofit2.Call<ExplainResponse> explain(@Query("c")
 String context,
 @Query("p")
 String policyName,
 @Query("filename")
 String filename,
 @Body
 String text)

compilePolicy

@Headers({"Accept: application/json","Content-Type: text/plain"})
@POST("/api/policies/compile")
retrofit2.Call<String> compilePolicy(@Body
 String text)

reidentify

@POST("/api/reidentify")
retrofit2.Call<String> reidentify(@Query("owner")
 String owner,
 @Body
 ReidentifyRequest request)

health

@Headers("Accept: application/json")
@GET("/api/health")
retrofit2.Call<StatusResponse> health()

status

@Headers("Accept: application/json")
@GET("/api/status")
retrofit2.Call<StatusResponse> status()

signingKey

@Headers("Accept: application/json")
@GET("/api/signing-key")
retrofit2.Call<String> signingKey()

getPolicies

@Headers("Accept: application/json")
@GET("/api/policies")
retrofit2.Call<List<String>> getPolicies(@Query("owner")
 String owner,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

getPolicy

@Headers("Accept: application/json")
@GET("/api/policies/{policyName}")
retrofit2.Call<String> getPolicy(@Path("policyName")
 String policyName,
 @Query("owner")
 String owner)

savePolicy

@Headers("Content-Type: application/json")
@POST("/api/policies")
retrofit2.Call<Void> savePolicy(@Query("name")
 String name,
 @Query("owner")
 String owner,
 @Body
 String json)

deletePolicy

@DELETE("/api/policies/{policyName}")
retrofit2.Call<Void> deletePolicy(@Path("policyName")
 String policyName,
 @Query("owner")
 String owner)

getPolicyVersions

@Headers("Accept: application/json")
@GET("/api/policies/{policyName}/versions")
retrofit2.Call<List<PolicyVersionSummary>> getPolicyVersions(@Path("policyName")
 String policyName,
 @Query("owner")
 String owner,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

getPolicyVersion

@Headers("Accept: application/json")
@GET("/api/policies/{policyName}/versions/{revision}")
retrofit2.Call<String> getPolicyVersion(@Path("policyName")
 String policyName,
 @Path("revision")
 int revision,
 @Query("owner")
 String owner)

getPolicyDiff

@Headers("Accept: application/json")
@GET("/api/policies/{policyName}/diff")
retrofit2.Call<String> getPolicyDiff(@Path("policyName")
 String policyName,
 @Query("from")
 int from,
 @Query("to")
 int to,
 @Query("owner")
 String owner)

rollbackPolicy

@Headers("Accept: application/json")
@POST("/api/policies/{policyName}/rollback")
retrofit2.Call<PolicyRollbackResponse> rollbackPolicy(@Path("policyName")
 String policyName,
 @Query("revision")
 int revision,
 @Query("owner")
 String owner)

getContexts

@GET("/api/contexts")
retrofit2.Call<String> getContexts(@Query("owner")
 String owner,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

createContext

@POST("/api/contexts")
retrofit2.Call<GenericResponse> createContext(@Query("name")
 String name,
 @Query("entity_type_disambiguation")
 Boolean entityTypeDisambiguation,
 @Query("ledger")
 Boolean ledger)

getContext

@GET("/api/contexts/{name}")
retrofit2.Call<String> getContext(@Path("name")
 String name)

updateContext

@PUT("/api/contexts/{name}")
retrofit2.Call<GenericResponse> updateContext(@Path("name")
 String name,
 @Query("entity_type_disambiguation")
 Boolean entityTypeDisambiguation,
 @Query("ledger")
 Boolean ledger)

deleteContext

@DELETE("/api/contexts/{name}")
retrofit2.Call<GenericResponse> deleteContext(@Path("name")
 String name)

getContextEntries

@GET("/api/contexts/{name}/entries")
retrofit2.Call<String> getContextEntries(@Path("name")
 String name,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

deleteContextEntries

@DELETE("/api/contexts/{name}/entries")
retrofit2.Call<GenericResponse> deleteContextEntries(@Path("name")
 String name)

exportContextEntries

@GET("/api/contexts/{name}/entries/export")
retrofit2.Call<String> exportContextEntries(@Path("name")
 String name,
 @Query("owner")
 String owner)

importContextEntries

@Headers("Content-Type: application/json")
@POST("/api/contexts/{name}/entries/import")
retrofit2.Call<String> importContextEntries(@Path("name")
 String name,
 @Query("on_conflict")
 String onConflict,
 @Query("owner")
 String owner,
 @Body
 String json)

deleteContextEntry

@DELETE("/api/contexts/{name}/entries/{entryId}")
retrofit2.Call<GenericResponse> deleteContextEntry(@Path("name")
 String name,
 @Path("entryId")
 String entryId)

getDocuments

@Headers("Accept: application/json")
@GET("/api/documents")
retrofit2.Call<String> getDocuments(@Query("owner")
 String owner,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

getDocument

@Streaming
@GET("/api/documents/{documentId}")
retrofit2.Call<okhttp3.ResponseBody> getDocument(@Path("documentId")
 String documentId,
 @Query("owner")
 String owner)

deleteDocument

@DELETE("/api/documents/{documentId}")
retrofit2.Call<Void> deleteDocument(@Path("documentId")
 String documentId,
 @Query("owner")
 String owner)

getDocumentStatus

@Headers("Accept: application/json")
@GET("/api/documents/{documentId}/status")
retrofit2.Call<String> getDocumentStatus(@Path("documentId")
 String documentId,
 @Query("owner")
 String owner)

getHolds

@Headers("Accept: application/json")
@GET("/api/holds")
retrofit2.Call<List<LegalHoldResponse>> getHolds(@Query("owner")
 String owner,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

createHold

@Headers({"Accept: application/json","Content-Type: application/json"})
@POST("/api/holds")
retrofit2.Call<LegalHoldResponse> createHold(@Query("owner")
 String owner,
 @Body
 LegalHoldRequest request)

getHold

@Headers("Accept: application/json")
@GET("/api/holds/{reference}")
retrofit2.Call<LegalHoldResponse> getHold(@Path("reference")
 String reference,
 @Query("owner")
 String owner)

deleteHold

@DELETE("/api/holds/{reference}")
retrofit2.Call<Void> deleteHold(@Path("reference")
 String reference,
 @Query("owner")
 String owner)

getLedger

@GET("/api/ledger")
retrofit2.Call<String> getLedger(@Query("q")
 String query,
 @Query("owner")
 String owner,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

getLedgerEntry

@GET("/api/ledger/{documentId}")
retrofit2.Call<String> getLedgerEntry(@Path("documentId")
 String documentId,
 @Query("owner")
 String owner)

exportLedger

@GET("/api/ledger/{documentId}/export")
retrofit2.Call<String> exportLedger(@Path("documentId")
 String documentId,
 @Query("owner")
 String owner)

isLedgerValid

@GET("/api/ledger/{documentId}/valid")
retrofit2.Call<String> isLedgerValid(@Path("documentId")
 String documentId,
 @Query("owner")
 String owner)

getLists

@GET("/api/lists")
retrofit2.Call<String> getLists(@Query("owner")
 String owner)

saveList

@Headers("Content-Type: application/json")
@POST("/api/lists/{list}")
retrofit2.Call<GenericResponse> saveList(@Path("list")
 String list,
 @Query("description")
 String description,
 @Query("owner")
 String owner,
 @Body
 List<String> values)

deleteList

@DELETE("/api/lists/{list}")
retrofit2.Call<Void> deleteList(@Path("list")
 String list,
 @Query("owner")
 String owner)

getList

@Headers("Accept: application/json")
@GET("/api/lists/{name}")
retrofit2.Call<GetListsResponse> getList(@Path("name")
 String name,
 @Query("owner")
 String owner)

getRedactLists

@Headers("Accept: application/json")
@GET("/api/redact-lists")
retrofit2.Call<String> getRedactLists(@Query("owner")
 String owner)

createRedactList

@Headers("Content-Type: application/json")
@POST("/api/redact-lists")
retrofit2.Call<GenericResponse> createRedactList(@Query("owner")
 String owner,
 @Body
 String json)

updateRedactList

@Headers("Content-Type: application/json")
@PUT("/api/redact-lists")
retrofit2.Call<GenericResponse> updateRedactList(@Query("owner")
 String owner,
 @Body
 String json)