com.contentful.java.cma

Interface ServiceTaxonomy

public interface ServiceTaxonomy

Service class to define the REST interface for taxonomy-related operations.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Flowable<CMAConcept>	createConcept(String organizationId, CMAConcept concept)
io.reactivex.Flowable<CMAConceptScheme>	createConceptScheme(String organizationId, CMAConceptScheme conceptScheme)
io.reactivex.Flowable<CMAConceptScheme>	createConceptSchemeWithId(String organizationId, String conceptSchemeId, CMAConceptScheme conceptScheme)
io.reactivex.Flowable<CMAConcept>	createConceptWithId(String organizationId, String conceptId, CMAConcept concept)
io.reactivex.Flowable<retrofit2.Response<Void>>	deleteConcept(String organizationId, String conceptId)
io.reactivex.Flowable<retrofit2.Response<Void>>	deleteConceptScheme(String organizationId, String conceptSchemeId)
io.reactivex.Flowable<CMAConcept>	fetchConcept(String organizationId, String conceptId) Concept Endpoints
io.reactivex.Flowable<CMAArray<CMAConcept>>	fetchConceptAncestors(String organizationId, String conceptId, Map<String,String> query)
io.reactivex.Flowable<CMAArray<CMAConcept>>	fetchConceptDescendants(String organizationId, String conceptId, Map<String,String> query)
io.reactivex.Flowable<CMAArray<CMAConcept>>	fetchConcepts(String organizationId, Map<String,String> query)
io.reactivex.Flowable<CMAConceptScheme>	fetchConceptScheme(String organizationId, String conceptSchemeId) Concept Scheme Endpoints
io.reactivex.Flowable<CMAArray<CMAConceptScheme>>	fetchConceptSchemes(String organizationId, Map<String,String> query)
io.reactivex.Flowable<CMATotalConcepts>	fetchTotalConcepts(String organizationId)
io.reactivex.Flowable<CMATotalConcepts>	fetchTotalConceptSchemes(String organizationId)
io.reactivex.Flowable<CMAConcept>	updateConcept(String organizationId, String conceptId, int version, List<Map<String,Object>> operations)
io.reactivex.Flowable<CMAConceptScheme>	updateConceptScheme(String organizationId, String conceptSchemeId, int version, Map<String,Object> operations)

Method Detail

fetchConcept

@GET(value="organizations/{organizationId}/taxonomy/concepts/{id}")
io.reactivex.Flowable<CMAConcept> fetchConcept(@Path(value="organizationId")
                                                                                                                   String organizationId,
                                                                                                                   @Path(value="id")
                                                                                                                   String conceptId)

Concept Endpoints

updateConcept

@PATCH(value="organizations/{organizationId}/taxonomy/concepts/{id}")
 @Headers(value="Content-Type: application/json-patch+json")
io.reactivex.Flowable<CMAConcept> updateConcept(@Path(value="organizationId")
                                                                                                                                                                                   String organizationId,
                                                                                                                                                                                   @Path(value="id")
                                                                                                                                                                                   String conceptId,
                                                                                                                                                                                   @Header(value="X-Contentful-Version")
                                                                                                                                                                                   int version,
                                                                                                                                                                                   @Body
                                                                                                                                                                                   List<Map<String,Object>> operations)

deleteConcept

@DELETE(value="organizations/{organizationId}/taxonomy/concepts/{id}")
io.reactivex.Flowable<retrofit2.Response<Void>> deleteConcept(@Path(value="organizationId")
                                                                                                                                     String organizationId,
                                                                                                                                     @Path(value="id")
                                                                                                                                     String conceptId)

createConcept

@POST(value="organizations/{organizationId}/taxonomy/concepts")
io.reactivex.Flowable<CMAConcept> createConcept(@Path(value="organizationId")
                                                                                                                String organizationId,
                                                                                                                @Body
                                                                                                                CMAConcept concept)

createConceptWithId

@PUT(value="organizations/{organizationId}/taxonomy/concepts/{conceptId}")
io.reactivex.Flowable<CMAConcept> createConceptWithId(@Path(value="organizationId")
                                                                                                                                 String organizationId,
                                                                                                                                 @Path(value="conceptId")
                                                                                                                                 String conceptId,
                                                                                                                                 @Body
                                                                                                                                 CMAConcept concept)

fetchConcepts

@GET(value="organizations/{organizationId}/taxonomy/concepts")
io.reactivex.Flowable<CMAArray<CMAConcept>> fetchConcepts(@Path(value="organizationId")
                                                                                                                         String organizationId,
                                                                                                                         @QueryMap
                                                                                                                         Map<String,String> query)

fetchConceptDescendants

@GET(value="organizations/{organizationId}/taxonomy/concepts/{id}/descendants")
io.reactivex.Flowable<CMAArray<CMAConcept>> fetchConceptDescendants(@Path(value="organizationId")
                                                                                                                                                    String organizationId,
                                                                                                                                                    @Path(value="id")
                                                                                                                                                    String conceptId,
                                                                                                                                                    @QueryMap
                                                                                                                                                    Map<String,String> query)

fetchConceptAncestors

@GET(value="organizations/{organizationId}/taxonomy/concepts/{id}/ancestors")
io.reactivex.Flowable<CMAArray<CMAConcept>> fetchConceptAncestors(@Path(value="organizationId")
                                                                                                                                                String organizationId,
                                                                                                                                                @Path(value="id")
                                                                                                                                                String conceptId,
                                                                                                                                                @QueryMap
                                                                                                                                                Map<String,String> query)

fetchTotalConcepts

@GET(value="organizations/{organizationId}/taxonomy/concepts/total")
io.reactivex.Flowable<CMATotalConcepts> fetchTotalConcepts(@Path(value="organizationId")
                                                                                                                                String organizationId)

fetchConceptScheme

@GET(value="organizations/{organizationId}/taxonomy/concept-schemes/{conceptSchemeId}")
io.reactivex.Flowable<CMAConceptScheme> fetchConceptScheme(@Path(value="organizationId")
                                                                                                                                                   String organizationId,
                                                                                                                                                   @Path(value="conceptSchemeId")
                                                                                                                                                   String conceptSchemeId)

Concept Scheme Endpoints

updateConceptScheme

@PATCH(value="organizations/{organizationId}/taxonomy/concept-schemes/{conceptSchemeId}")
io.reactivex.Flowable<CMAConceptScheme> updateConceptScheme(@Path(value="organizationId")
                                                                                                                                                      String organizationId,
                                                                                                                                                      @Path(value="conceptSchemeId")
                                                                                                                                                      String conceptSchemeId,
                                                                                                                                                      @Header(value="X-Contentful-Version")
                                                                                                                                                      int version,
                                                                                                                                                      @Body
                                                                                                                                                      Map<String,Object> operations)

deleteConceptScheme

@DELETE(value="organizations/{organizationId}/taxonomy/concept-schemes/{conceptSchemeId}")
io.reactivex.Flowable<retrofit2.Response<Void>> deleteConceptScheme(@Path(value="organizationId")
                                                                                                                                                               String organizationId,
                                                                                                                                                               @Path(value="conceptSchemeId")
                                                                                                                                                               String conceptSchemeId)

createConceptScheme

@POST(value="organizations/{organizationId}/taxonomy/concept-schemes")
io.reactivex.Flowable<CMAConceptScheme> createConceptScheme(@Path(value="organizationId")
                                                                                                                                   String organizationId,
                                                                                                                                   @Body
                                                                                                                                   CMAConceptScheme conceptScheme)

createConceptSchemeWithId

@PUT(value="organizations/{organizationId}/taxonomy/concept-schemes/{conceptSchemeId}")
io.reactivex.Flowable<CMAConceptScheme> createConceptSchemeWithId(@Path(value="organizationId")
                                                                                                                                                          String organizationId,
                                                                                                                                                          @Path(value="conceptSchemeId")
                                                                                                                                                          String conceptSchemeId,
                                                                                                                                                          @Body
                                                                                                                                                          CMAConceptScheme conceptScheme)

fetchConceptSchemes

@GET(value="organizations/{organizationId}/taxonomy/concept-schemes")
io.reactivex.Flowable<CMAArray<CMAConceptScheme>> fetchConceptSchemes(@Path(value="organizationId")
                                                                                                                                            String organizationId,
                                                                                                                                            @QueryMap
                                                                                                                                            Map<String,String> query)

fetchTotalConceptSchemes

@GET(value="organizations/{organizationId}/taxonomy/concepts-schemes/total")
io.reactivex.Flowable<CMATotalConcepts> fetchTotalConceptSchemes(@Path(value="organizationId")
                                                                                                                                              String organizationId)