Versionen im Vergleich

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) BoMetaService:

Codeblock
@Path("/bo_metas")
 
 @GET
 @RestServiceInfo(identifier="bometa_list", isFinalized=true, description="List of all readable Businessobject-metas")

 @GET
 @Path("/{bo_meta_id}")
 @RestServiceInfo(identifier="bometa_self", isFinalized=true, description="Get the meta information about one Businessobject-meta")

 

3) BoService:

Codeblock
@Path("/bo_metas/{bo_meta_id}/bos")
 
 @GET
 @RestServiceInfo(identifier="bo_list", description="List of Data (Rows)")
 
 @POST
 @RestServiceInfo(identifier="boinsert", description="Data Row Insert")
 @Consumes({MediaType.APPLICATION_JSON})
 
 @GET
 @Path("/{bo_id}")
 @RestServiceInfo(identifier="bo_self", description="Full Data Row Details")
 
 @PUT
 @Path("/{bo_id}")
 @RestServiceInfo(identifier="boupdate", description="Full Data Row Update")
 @Consumes({MediaType.APPLICATION_JSON})
 
 @DELETE
 @Path("/{bo_id}")
 @RestServiceInfo(identifier="bodelete", description="Full Data Row Delete")
 

 

4) DependenceService:

Codeblock@Path("/bo_metas/{bo_meta_id}/bos/{bo_id}/dependencies") @GET @RestServiceInfo(identifier="dependencies", description="List of Dependency-Metas") @GET @Path("/{reffield}/dep_bos") @RestServiceInfo(identifier="dependence_list", description="List of Dependence-Data (Rows)")   @GET @Path("/{reffield}/dep_bos/{dependence_id}") @RestServiceInfo(identifier="dependence_self", description="Full Data Row Details of Dependency")   @GET  @Produces(MediaType.APPLICATION_OCTET_STREAM) @Path("/{reffield}/documents/{document_id}") @RestServiceInfo(identifier="document", description="Document Provider")
http://localhost:8080/nuclos-war/rest/...