Hier wird der RESTful Service ab der Version 4.3 beschrieben. Für die alte Version (bis 4.2) bitte hier nachlesen: RESTful Service bis 4.2
1) LoginService:
@Path("/") @POST @Consumes({MediaType.APPLICATION_JSON}) @RestServiceInfo(identifier="login", isFinalized=true, description="User-Login. Returns JsonObject with SessionID and link for BO-Metalist.", examplePostData = "{\"username\": \"nuclos\", \"password\": \"\"}") @DELETE @RestServiceInfo(identifier="logout", isFinalized=true, description="User-Logout. Returns HTTP-Status 200, if successful") @GET @Path("version") @RestServiceInfo(identifier="version", isFinalized=true, description="Version of the current Nuclos-Server") @GET @Path("dbversion") @RestServiceInfo(identifier="dbversion", isFinalized=true, description="Version of DB-Schema of the current Nuclos-Server. Actually accesses the DB.")
2) MetaService:
@Path("/meta") @GET @Path("/bo") @RestServiceInfo(identifier="bometalist", description="List of all readable Businessobject-metas") @GET @Path("/bo/{id}") @RestServiceInfo(identifier="bometainfo", description="Get the meta information about one Businessobject-meta") @GET @Path("/menu") @RestServiceInfo(identifier="menu", description="List of the menu-items. Includes all Businessobject-metas") @GET @Path("/layout/{layout_id}") @RestServiceInfo(identifier="layout", description="Parsed layout for the corresponding layout-id")
3) BoService:
@Path("/bo") @GET @Path("/{bo_meta_id}") @RestServiceInfo(identifier="bolist", description="List of Data (Rows)") @POST @Path("/{bo_meta_id}") @RestServiceInfo(identifier="boinsert", description="Data Row Insert") @Consumes({MediaType.APPLICATION_JSON}) @GET @Path("/{bo_meta_id}/{bo_id}") @RestServiceInfo(identifier="boget", description="Full Data Row Get") @PUT @Path("/{bo_meta_id}/{bo_id}") @RestServiceInfo(identifier="boupdate", description="Full Data Row Update") @Consumes({MediaType.APPLICATION_JSON}) @DELETE @Path("/{bo_meta_id}/{bo_id}") @RestServiceInfo(identifier="bodelete", description="Full Data Row Delete") @GET @Path("/{bo_meta_id}/{bo_id}/dependence") @RestServiceInfo(identifier="dependencies", description="List of Subforms") @GET @Path("/{bo_meta_id}/{bo_id}/dependence/{reffield}") @RestServiceInfo(identifier="dependencelist", description="List of Subform-Data (Rows)") @GET @Path("/{bo_meta_id}/{bo_id}/dependence/{reffield}/{dependence_id}") @RestServiceInfo(identifier="dependencyget", description="Full Data Row Get of Subform") @GET @Produces(MediaType.APPLICATION_OCTET_STREAM) @Path("/{bo_meta_id}/{bo_id}/document/{reffield}/{document_id}") @RestServiceInfo(identifier="document", description="Document Provider")
Überblick
Inhalte