Versionen im Vergleich

Alte Version 150

changes.mady.by.user Oliver Brausch

Gespeichert am

verglichen mit

Neue Version Aktuell

changes.mady.by.user Inga Sertel

Gespeichert am

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Anzeige untergeordneter Seiten


Er ist unter dem Pfad

Codeblock
/rest

zu erreichen, z.B. für eine lokale Installation des Servers auf dem Port 8080:

Hinweis
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:

Codeblock
@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:

Codeblock
@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) DataService:

Codeblock@Path("/data")    @GET  @Path("/{bometa_id}")  @RestServiceInfo(identifier="list", description="List of Data (Rows)")    @POST  @Path("/{bometa_id}")  @RestServiceInfo(identifier="insert", description="Data Row Insert")  @Consumes({MediaType.APPLICATION_JSON})    @GET  @Path("/{bometa_id}/{id}")  @RestServiceInfo(identifier="get", description="Full Data Row Get")    @PUT  @Path("/{bometa_id}/{id}")  @RestServiceInfo(identifier="update", description="Full Data Row Update")  @Consumes({MediaType.APPLICATION_JSON})    @DELETE  @Path("/{bometa_id}/{id}")  @RestServiceInfo(identifier="delete", description="Full Data Row Delete")   @GET @Path("/{bometa_id}/{id}/subform") @RestServiceInfo(identifier="dependencies", description="List of Subforms") @GET @Path("/{bometa_id}/{id}/subform/{reffield}") @RestServiceInfo(identifier="dependencelist", description="List of Subform-Data (Rows)")   @GET @Path("/{bometa_id}/{id}/subform/{reffield}/{sid}") @RestServiceInfo(identifier="dependencyget", description="Full Data Row Get of Subform")   @GET  @Produces(MediaType.APPLICATION_OCTET_STREAM) @Path("/{bometa_id}/{id}/document/{reffield}/{sid}") @RestServiceInfo(identifier="document", description="Document Provider")
http://localhost:8080/nuclos-war/rest/...