Seitenhistorie
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) BoService:
Codeblock |
---|
@Path("/bo")
@GET
@RestServiceInfo(identifier="bometa_list", isFinalized=true, description="List of all readable Businessobject-metas")
@GET
@Path("/{bo_meta_id}/row")
@RestServiceInfo(identifier="bo_list", description="List of Data (Rows)")
@POST
@Path("/{bo_meta_id}/row")
@RestServiceInfo(identifier="boinsert", description="Data Row Insert")
@Consumes({MediaType.APPLICATION_JSON})
@GET
@Path("/{bo_meta_id}/row/{bo_id}")
@RestServiceInfo(identifier="bodetails", description="Full Data Row Details")
@PUT
@Path("/{bo_meta_id}/row/{bo_id}")
@RestServiceInfo(identifier="boupdate", description="Full Data Row Update")
@Consumes({MediaType.APPLICATION_JSON})
@DELETE
@Path("/{bo_meta_id}/row/{bo_id}")
@RestServiceInfo(identifier="bodelete", description="Full Data Row Delete")
@GET
@Path("/{bo_meta_id}/row/{bo_id}/dependence")
@RestServiceInfo(identifier="dependencies", description="List of Dependencies")
@GET
@Path("/{bo_meta_id}/row/{bo_id}/dependence/{reffield}")
@RestServiceInfo(identifier="dependencelist", description="List of Dependence-Data (Rows)")
@GET
@Path("/{bo_meta_id}/row/{bo_id}/dependence/{reffield}/{dependence_id}")
@RestServiceInfo(identifier="dependencydetails", description="Full Data Row Details of Dependency")
@GET
@Produces(MediaType.APPLICATION_OCTET_STREAM)
@Path("/{bo_meta_id}/row/{bo_id}/document/{reffield}/{document_id}")
@RestServiceInfo(identifier="document", description="Document Provider") |
2) BoMetaService:
http://localhost:8080/nuclos-war/rest/...
Überblick
Inhalte