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", description="User-Login. Returns JsonObject with SessionID and link for BO-Metalist.", examplePostData = "{\"username\": \"nuclos\", \"password\": \"\"}") @DELETE @RestServiceInfo(identifier="logout", description="User-Logout. Returns HTTP-Status 200, if successful") @GET @Path("/version") @RestServiceInfo(identifier="version", description="Version of the current Nuclos-Server") @GET @Path("/dbversion") @RestServiceInfo(identifier="dbversion", description="Version of DB-Schema of the current Nuclos-Server. Actually accesses the DB.")
2) MetaService:
@Path("/meta") @GET @Path("/bometa") @RestServiceInfo(identifier="bometalist", description="List of all readable Businessobject-metas") @GET @Path("/bometa/{id}") @RestServiceInfo(identifier="bometa", 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")
3) DataService:
@Path("/data") @GET @Path("/{bometa}") @RestServiceInfo(identifier="list", description="List of Data (Rows)") @POST @Path("/{bometa}") @RestServiceInfo(identifier="insert", description="Data Row Insert") @Consumes({MediaType.APPLICATION_JSON}) @GET @Path("/{bometa}/{id}") @RestServiceInfo(identifier="get", description="Full Data Row Get") @PUT @Path("/{bometa}/{id}") @RestServiceInfo(identifier="update", description="Full Data Row Update") @Consumes({MediaType.APPLICATION_JSON}) @DELETE @Path("/{bometa}/{id}") @RestServiceInfo(identifier="delete", description="Full Data Row Delete") @GET @Path("/{bometa}/{id}/subform") @RestServiceInfo(identifier="subformlist", description="List of Subforms") @GET @Path("/{bometa}/{id}/subform/{reffield}") @RestServiceInfo(identifier="subformdata", description="List of Subform-Data (Rows)") @GET @Path("/{bometa}/{id}/subform/{reffield}/{sid}") @RestServiceInfo(identifier="subget", description="Full Data Row Get of Subform")
Überblick
Inhalte