Interface RepositoryAPI


  • public interface RepositoryAPI
    • Method Detail

      • fetchDocumentRoot

        @GET("repo/{repositoryName}/path/")
        retrofit2.Call<Document> fetchDocumentRoot​(@Path("repositoryName")
                                                   java.lang.String repositoryName)
      • fetchDocumentRoot

        @GET("path/")
        retrofit2.Call<Document> fetchDocumentRoot()
      • fetchDocumentById

        @GET("repo/{repositoryName}/id/{documentId}")
        retrofit2.Call<Document> fetchDocumentById​(@Path("documentId")
                                                   java.lang.String documentId,
                                                   @Path("repositoryName")
                                                   java.lang.String repositoryName)
      • createDocumentById

        @POST("repo/{repositoryName}/id/{parentId}")
        retrofit2.Call<Document> createDocumentById​(@Path("parentId")
                                                    java.lang.String parentId,
                                                    @Body
                                                    Document document,
                                                    @Path("repositoryName")
                                                    java.lang.String repositoryName)
      • updateDocument

        @PUT("repo/{repositoryName}/id/{documentId}")
        retrofit2.Call<Document> updateDocument​(@Path("documentId")
                                                java.lang.String documentId,
                                                @Body
                                                Document document,
                                                @Path("repositoryName")
                                                java.lang.String repositoryName)
      • deleteDocument

        @DELETE("repo/{repositoryName}/id/{documentId}")
        retrofit2.Call<okhttp3.ResponseBody> deleteDocument​(@Path("documentId")
                                                            java.lang.String documentId,
                                                            @Path("repositoryName")
                                                            java.lang.String repositoryName)
      • fetchDocumentById

        @GET("id/{documentId}")
        retrofit2.Call<Document> fetchDocumentById​(@Path("documentId")
                                                   java.lang.String documentId)
      • createDocumentById

        @POST("id/{parentId}")
        retrofit2.Call<Document> createDocumentById​(@Path("parentId")
                                                    java.lang.String parentId,
                                                    @Body
                                                    Document document)
      • updateDocument

        @PUT("id/{documentId}")
        retrofit2.Call<Document> updateDocument​(@Path("documentId")
                                                java.lang.String documentId,
                                                @Body
                                                Document document)
      • deleteDocument

        @DELETE("id/{documentId}")
        retrofit2.Call<okhttp3.ResponseBody> deleteDocument​(@Path("documentId")
                                                            java.lang.String documentId)
      • fetchDocumentByPath

        @GET("repo/{repositoryName}/path{docPath}")
        retrofit2.Call<Document> fetchDocumentByPath​(@Path(value="docPath",encoded=true)
                                                     java.lang.String docPath,
                                                     @Path("repositoryName")
                                                     java.lang.String repositoryName)
      • createDocumentByPath

        @POST("repo/{repositoryName}/path{parentPath}")
        retrofit2.Call<Document> createDocumentByPath​(@Path("parentPath")
                                                      java.lang.String parentPath,
                                                      @Body
                                                      Document document,
                                                      @Path("repositoryName")
                                                      java.lang.String repositoryName)
      • fetchDocumentByPath

        @GET("path{documentPath}")
        retrofit2.Call<Document> fetchDocumentByPath​(@Path(value="documentPath",encoded=true)
                                                     java.lang.String docPath)
      • createDocumentByPath

        @POST("path{parentPath}")
        retrofit2.Call<Document> createDocumentByPath​(@Path(value="parentPath",encoded=true)
                                                      java.lang.String parentPath,
                                                      @Body
                                                      Document document)
      • query

        @GET("query")
        retrofit2.Call<Documents> query​(@Query("query")
                                        java.lang.String query)
      • query

        @GET("query")
        retrofit2.Call<Documents> query​(@Query("query")
                                        java.lang.String query,
                                        @Query("pageSize")
                                        java.lang.String pageSize,
                                        @Query("currentPageIndex")
                                        java.lang.String currentPageIndex,
                                        @Query("maxResults")
                                        java.lang.String maxResults,
                                        @Query("sortBy")
                                        java.lang.String sortBy,
                                        @Query("sortOrder")
                                        java.lang.String sortOrder,
                                        @Query("queryParams")
                                        java.lang.String queryParams)
      • queryByProvider

        @GET("query/{providerName}")
        retrofit2.Call<Documents> queryByProvider​(@Path("providerName")
                                                  java.lang.String providerName,
                                                  @Query("pageSize")
                                                  java.lang.String pageSize,
                                                  @Query("currentPageIndex")
                                                  java.lang.String currentPageIndex,
                                                  @Query("maxResults")
                                                  java.lang.String maxResults,
                                                  @Query("sortBy")
                                                  java.lang.String sortBy,
                                                  @Query("sortOrder")
                                                  java.lang.String sortOrder,
                                                  @Query("queryParams")
                                                  java.lang.String queryParams)
      • fetchAuditByPath

        @GET("path{documentPath}/@audit")
        retrofit2.Call<Audit> fetchAuditByPath​(@Path(value="documentPath",encoded=true)
                                               java.lang.String documentPath)
      • fetchAuditById

        @GET("id/{documentId}/@audit")
        retrofit2.Call<Audit> fetchAuditById​(@Path("documentId")
                                             java.lang.String documentId)
      • fetchAuditByPath

        @GET("repo/{repositoryName}/path{documentPath}/@audit")
        retrofit2.Call<Audit> fetchAuditByPath​(@Path(value="documentPath",encoded=true)
                                               java.lang.String documentPath,
                                               @Path("repositoryName")
                                               java.lang.String repositoryName)
      • fetchAuditById

        @GET("repo/{repositoryName}/id/{documentId}/@audit")
        retrofit2.Call<Audit> fetchAuditById​(@Path("documentId")
                                             java.lang.String documentId,
                                             @Path("repositoryName")
                                             java.lang.String repositoryName)
      • fetchPermissionsByPath

        @GET("path{documentPath}/@acl")
        retrofit2.Call<ACP> fetchPermissionsByPath​(@Path(value="documentPath",encoded=true)
                                                   java.lang.String documentPath)
      • fetchPermissionsById

        @GET("id/{documentId}/@acl")
        retrofit2.Call<ACP> fetchPermissionsById​(@Path("documentId")
                                                 java.lang.String documentId)
      • fetchPermissionsByPath

        @GET("repo/{repositoryName}/path{documentPath}/@acl")
        retrofit2.Call<ACP> fetchPermissionsByPath​(@Path(value="documentPath",encoded=true)
                                                   java.lang.String documentPath,
                                                   @Path("repositoryName")
                                                   java.lang.String repositoryName)
      • fetchPermissionsById

        @GET("repo/{repositoryName}/id/{documentId}/@acl")
        retrofit2.Call<ACP> fetchPermissionsById​(@Path("documentId")
                                                 java.lang.String documentId,
                                                 @Path("repositoryName")
                                                 java.lang.String repositoryName)
      • fetchChildrenByPath

        @GET("path{parentPath}/@children")
        retrofit2.Call<Documents> fetchChildrenByPath​(@Path(value="parentPath",encoded=true)
                                                      java.lang.String parentPath)
      • fetchChildrenById

        @GET("id/{parentId}/@children")
        retrofit2.Call<Documents> fetchChildrenById​(@Path("parentId")
                                                    java.lang.String parentId)
      • fetchChildrenByPath

        @GET("repo/{repositoryName}/path{parentPath}/@children")
        retrofit2.Call<Documents> fetchChildrenByPath​(@Path(value="parentPath",encoded=true)
                                                      java.lang.String parentPath,
                                                      @Path("repositoryName")
                                                      java.lang.String repositoryName)
      • fetchChildrenById

        @GET("repo/{repositoryName}/id/{parentId}/@children")
        retrofit2.Call<Documents> fetchChildrenById​(@Path("parentId")
                                                    java.lang.String parentId,
                                                    @Path("repositoryName")
                                                    java.lang.String repositoryName)
      • fetchBlobByPath

        @Deprecated
        @GET("path{documentPath}/@blob/{fieldPath}")
        retrofit2.Call<FileBlob> fetchBlobByPath​(@Path(value="documentPath",encoded=true)
                                                 java.lang.String documentPath,
                                                 @Path(value="fieldPath",encoded=true)
                                                 java.lang.String fieldPath)
        Deprecated.
        since 3.1
      • fetchBlobById

        @Deprecated
        @GET("id/{documentId}/@blob/{fieldPath}")
        retrofit2.Call<FileBlob> fetchBlobById​(@Path("documentId")
                                               java.lang.String documentId,
                                               @Path(value="fieldPath",encoded=true)
                                               java.lang.String fieldPath)
        Deprecated.
        since 3.1
      • fetchBlobByPath

        @Deprecated
        @GET("repo/{repositoryName}/path{documentPath}/@blob/{fieldPath}")
        retrofit2.Call<FileBlob> fetchBlobByPath​(@Path(value="documentPath",encoded=true)
                                                 java.lang.String documentPath,
                                                 @Path(value="fieldPath",encoded=true)
                                                 java.lang.String fieldPath,
                                                 @Path("repositoryName")
                                                 java.lang.String repositoryName)
        Deprecated.
        since 3.1
      • fetchBlobById

        @Deprecated
        @GET("repo/{repositoryName}/id/{documentId}/@blob/{fieldPath}")
        retrofit2.Call<FileBlob> fetchBlobById​(@Path("documentId")
                                               java.lang.String documentId,
                                               @Path(value="fieldPath",encoded=true)
                                               java.lang.String fieldPath,
                                               @Path("repositoryName")
                                               java.lang.String repositoryName)
        Deprecated.
        since 3.1
      • streamBlobByPath

        @GET("path{documentPath}/@blob/{fieldPath}")
        retrofit2.Call<StreamBlob> streamBlobByPath​(@Path(value="documentPath",encoded=true)
                                                    java.lang.String documentPath,
                                                    @Path(value="fieldPath",encoded=true)
                                                    java.lang.String fieldPath)
      • streamBlobById

        @GET("id/{documentId}/@blob/{fieldPath}")
        retrofit2.Call<StreamBlob> streamBlobById​(@Path("documentId")
                                                  java.lang.String documentId,
                                                  @Path(value="fieldPath",encoded=true)
                                                  java.lang.String fieldPath)
      • streamBlobByPath

        @GET("repo/{repositoryName}/path{documentPath}/@blob/{fieldPath}")
        retrofit2.Call<StreamBlob> streamBlobByPath​(@Path(value="documentPath",encoded=true)
                                                    java.lang.String documentPath,
                                                    @Path(value="fieldPath",encoded=true)
                                                    java.lang.String fieldPath,
                                                    @Path("repositoryName")
                                                    java.lang.String repositoryName)
      • streamBlobById

        @GET("repo/{repositoryName}/id/{documentId}/@blob/{fieldPath}")
        retrofit2.Call<StreamBlob> streamBlobById​(@Path("documentId")
                                                  java.lang.String documentId,
                                                  @Path(value="fieldPath",encoded=true)
                                                  java.lang.String fieldPath,
                                                  @Path("repositoryName")
                                                  java.lang.String repositoryName)
      • startWorkflowInstanceWithDocId

        @POST("id/{documentId}/@workflow")
        retrofit2.Call<Workflow> startWorkflowInstanceWithDocId​(@Path("documentId")
                                                                java.lang.String documentId,
                                                                @Body
                                                                Workflow workflow)
      • startWorkflowInstanceWithDocId

        @POST("repo/{repositoryName}/id/{documentId}/@workflow")
        retrofit2.Call<Workflow> startWorkflowInstanceWithDocId​(@Path("documentId")
                                                                java.lang.String documentId,
                                                                @Body
                                                                Workflow workflow,
                                                                @Path("repositoryName")
                                                                java.lang.String repositoryName)
      • startWorkflowInstanceWithDocPath

        @POST("path{documentPath}/@workflow")
        retrofit2.Call<Workflow> startWorkflowInstanceWithDocPath​(@Path(value="documentPath",encoded=true)
                                                                  java.lang.String documentPath,
                                                                  @Body
                                                                  Workflow workflow)
      • startWorkflowInstanceWithDocPath

        @POST("repo/{repositoryName}/path{documentPath}/@workflow")
        retrofit2.Call<Workflow> startWorkflowInstanceWithDocPath​(@Path(value="documentPath",encoded=true)
                                                                  java.lang.String documentPath,
                                                                  @Body
                                                                  Workflow workflow,
                                                                  @Path("repositoryName")
                                                                  java.lang.String repositoryName)
      • fetchWorkflowInstances

        @GET("id/{documentId}/@workflow")
        retrofit2.Call<Workflows> fetchWorkflowInstances​(@Path("documentId")
                                                         java.lang.String documentId)
      • fetchWorkflowInstances

        @GET("repo/{repositoryName}/id/{documentId}/@workflow")
        retrofit2.Call<Workflows> fetchWorkflowInstances​(@Path("documentId")
                                                         java.lang.String documentId,
                                                         @Path("repositoryName")
                                                         java.lang.String repositoryName)
      • fetchWorkflowInstancesByDocPath

        @GET("path{documentPath}/@workflow")
        retrofit2.Call<Workflows> fetchWorkflowInstancesByDocPath​(@Path(value="documentPath",encoded=true)
                                                                  java.lang.String documentPath)
      • fetchWorkflowInstancesByDocPath

        @GET("repo/{repositoryName}/id/{documentId}/@workflow")
        retrofit2.Call<Workflows> fetchWorkflowInstancesByDocPath​(@Path("documentPath")
                                                                  java.lang.String documentPath,
                                                                  @Path("repositoryName")
                                                                  java.lang.String repositoryName)
      • fetchWorkflowInstance

        @GET("workflow/{workflowInstanceId}")
        retrofit2.Call<Workflow> fetchWorkflowInstance​(@Path("workflowInstanceId")
                                                       java.lang.String workflowInstanceId)
      • cancelWorkflowInstance

        @DELETE("workflow/{workflowInstanceId}")
        retrofit2.Call<okhttp3.ResponseBody> cancelWorkflowInstance​(@Path("workflowInstanceId")
                                                                    java.lang.String workflowInstanceId)
      • fetchWorkflowInstanceGraph

        @GET("workflow/{workflowInstanceId}/graph")
        retrofit2.Call<Graph> fetchWorkflowInstanceGraph​(@Path("workflowInstanceId")
                                                         java.lang.String workflowInstanceId)
      • fetchWorkflowModel

        @GET("workflowModel/{workflowModelName}")
        retrofit2.Call<Workflow> fetchWorkflowModel​(@Path("workflowModelName")
                                                    java.lang.String workflowModelName)
      • fetchWorkflowModelGraph

        @GET("workflowModel/{workflowModelName}/graph")
        retrofit2.Call<Graph> fetchWorkflowModelGraph​(@Path("workflowModelName")
                                                      java.lang.String workflowModelName)
      • fetchWorkflowModels

        @GET("workflowModel")
        retrofit2.Call<Workflows> fetchWorkflowModels()
      • createForAdapter

        @POST("id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<java.lang.Object> createForAdapter​(@Path("parentId")
                                                          java.lang.String documentId,
                                                          @Path("adapter")
                                                          java.lang.String adapter,
                                                          @Path(value="pathSuffix",encoded=true)
                                                          java.lang.String pathSuffix,
                                                          @QueryMap(encoded=true)
                                                          java.util.Map<java.lang.String,​java.io.Serializable> queryParams,
                                                          @Body
                                                          java.lang.Object object)
        Since:
        3.2
      • createForAdapter

        @POST("repo/{repositoryName}/id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<java.lang.Object> createForAdapter​(@Path("repositoryName")
                                                          java.lang.String repositoryName,
                                                          @Path("parentId")
                                                          java.lang.String documentId,
                                                          @Path("adapter")
                                                          java.lang.String adapter,
                                                          @Path(value="pathSuffix",encoded=true)
                                                          java.lang.String pathSuffix,
                                                          @QueryMap(encoded=true)
                                                          java.util.Map<java.lang.String,​java.io.Serializable> queryParams,
                                                          @Body
                                                          java.lang.Object object)
        Since:
        3.2
      • fetchForAdapter

        @GET("id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<java.lang.Object> fetchForAdapter​(@Path("parentId")
                                                         java.lang.String documentId,
                                                         @Path("adapter")
                                                         java.lang.String adapter,
                                                         @Path(value="pathSuffix",encoded=true)
                                                         java.lang.String pathSuffix,
                                                         @QueryMap(encoded=true)
                                                         java.util.Map<java.lang.String,​java.io.Serializable> queryParams)
        Since:
        3.2
      • fetchForAdapter

        @GET("repo/{repositoryName}/id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<java.lang.Object> fetchForAdapter​(@Path("repositoryName")
                                                         java.lang.String repositoryName,
                                                         @Path("parentId")
                                                         java.lang.String documentId,
                                                         @Path("adapter")
                                                         java.lang.String adapter,
                                                         @Path(value="pathSuffix",encoded=true)
                                                         java.lang.String pathSuffix,
                                                         @QueryMap(encoded=true)
                                                         java.util.Map<java.lang.String,​java.io.Serializable> queryParams)
        Since:
        3.2
      • updateForAdapter

        @PUT("id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<java.lang.Object> updateForAdapter​(@Path("parentId")
                                                          java.lang.String documentId,
                                                          @Path("adapter")
                                                          java.lang.String adapter,
                                                          @Path(value="pathSuffix",encoded=true)
                                                          java.lang.String pathSuffix,
                                                          @QueryMap(encoded=true)
                                                          java.util.Map<java.lang.String,​java.io.Serializable> queryParams,
                                                          @Body
                                                          java.lang.Object object)
        Since:
        3.2
      • updateForAdapter

        @PUT("repo/{repositoryName}/id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<java.lang.Object> updateForAdapter​(@Path("repositoryName")
                                                          java.lang.String repositoryName,
                                                          @Path("parentId")
                                                          java.lang.String documentId,
                                                          @Path("adapter")
                                                          java.lang.String adapter,
                                                          @Path(value="pathSuffix",encoded=true)
                                                          java.lang.String pathSuffix,
                                                          @QueryMap(encoded=true)
                                                          java.util.Map<java.lang.String,​java.io.Serializable> queryParams,
                                                          @Body
                                                          java.lang.Object object)
        Since:
        3.2
      • deleteForAdapter

        @DELETE("id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<okhttp3.ResponseBody> deleteForAdapter​(@Path("parentId")
                                                              java.lang.String documentId,
                                                              @Path("adapter")
                                                              java.lang.String adapter,
                                                              @Path(value="pathSuffix",encoded=true)
                                                              java.lang.String pathSuffix,
                                                              @QueryMap(encoded=true)
                                                              java.util.Map<java.lang.String,​java.io.Serializable> queryParams)
        Since:
        3.2
      • deleteForAdapter

        @DELETE("repo/{repositoryName}/id/{parentId}/@{adapter}/{pathSuffix}")
        retrofit2.Call<okhttp3.ResponseBody> deleteForAdapter​(@Path("repositoryName")
                                                              java.lang.String repositoryName,
                                                              @Path("parentId")
                                                              java.lang.String documentId,
                                                              @Path("adapter")
                                                              java.lang.String adapter,
                                                              @Path(value="pathSuffix",encoded=true)
                                                              java.lang.String pathSuffix,
                                                              @QueryMap(encoded=true)
                                                              java.util.Map<java.lang.String,​java.io.Serializable> queryParams)
        Since:
        3.2