org.codice.ddf.confluence.api

Interface SpaceResource

@Path(value="/space")
public interface SpaceResource

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	contents(String spaceKey, String depth, String expand, Integer start, Integer limit)
javax.ws.rs.core.Response	contentsWithType(String spaceKey, String type, String depth, String expand, Integer start, Integer limit)
javax.ws.rs.core.Response	createPrivateSpace()
javax.ws.rs.core.Response	createSpace()
javax.ws.rs.core.Response	deleteSpaceKey(String spaceKey)
javax.ws.rs.core.Response	space(String spaceKey, String expand)
javax.ws.rs.core.Response	spaces(String spaceKey, String type, String status, String label, String expand, Integer start, Integer limit)
javax.ws.rs.core.Response	update(String spaceKey)

Method Detail

spaces

@GET
 @Produces(value="application/json")
javax.ws.rs.core.Response spaces(@QueryParam(value="spaceKey")
                                                                           String spaceKey,
                                                                           @QueryParam(value="type")
                                                                           String type,
                                                                           @QueryParam(value="status")
                                                                           String status,
                                                                           @QueryParam(value="label")
                                                                           String label,
                                                                           @QueryParam(value="expand")
                                                                           String expand,
                                                                           @QueryParam(value="start")
                                                                           Integer start,
                                                                           @QueryParam(value="limit") @DefaultValue(value="25")
                                                                           Integer limit)

createSpace

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
javax.ws.rs.core.Response createSpace()

contentsWithType

@GET
 @Produces(value="application/json")
 @Path(value="/{spaceKey}/content/{type}")
javax.ws.rs.core.Response contentsWithType(@PathParam(value="spaceKey")
                                                                                                                                String spaceKey,
                                                                                                                                @PathParam(value="type")
                                                                                                                                String type,
                                                                                                                                @QueryParam(value="depth") @DefaultValue(value="all")
                                                                                                                                String depth,
                                                                                                                                @QueryParam(value="expand")
                                                                                                                                String expand,
                                                                                                                                @QueryParam(value="start")
                                                                                                                                Integer start,
                                                                                                                                @QueryParam(value="limit") @DefaultValue(value="25")
                                                                                                                                Integer limit)

createPrivateSpace

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/_private")
javax.ws.rs.core.Response createPrivateSpace()

update

@PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/{spaceKey}")
javax.ws.rs.core.Response update(@PathParam(value="spaceKey")
                                                                                                                                            String spaceKey)

deleteSpaceKey

@DELETE
 @Produces(value="application/json")
 @Path(value="/{spaceKey}")
javax.ws.rs.core.Response deleteSpaceKey(@PathParam(value="spaceKey")
                                                                                                                  String spaceKey)

contents

@GET
 @Produces(value="application/json")
 @Path(value="/{spaceKey}/content")
javax.ws.rs.core.Response contents(@PathParam(value="spaceKey")
                                                                                                                 String spaceKey,
                                                                                                                 @QueryParam(value="depth") @DefaultValue(value="all")
                                                                                                                 String depth,
                                                                                                                 @QueryParam(value="expand")
                                                                                                                 String expand,
                                                                                                                 @QueryParam(value="start")
                                                                                                                 Integer start,
                                                                                                                 @QueryParam(value="limit") @DefaultValue(value="25")
                                                                                                                 Integer limit)

space

@GET
 @Produces(value="application/json")
 @Path(value="/{spaceKey}")
javax.ws.rs.core.Response space(@PathParam(value="spaceKey")
                                                                                                      String spaceKey,
                                                                                                      @QueryParam(value="expand")
                                                                                                      String expand)