You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-36Lines changed: 1 addition & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,45 +127,10 @@ The source-code can be directly checked-out through this repository. It contains
127
127
* property `basePath` to `http://tomcatHost:tomcatPort/sss.adapter.rest.v2`
128
128
* property `swaggerUIDocBasePath` to `http://tomcatHost:tomcatPort/sss.adapter.rest.v2/api-docs`
129
129
* adapt Swagger property `url` of object `SwaggerUi` in `adapter/adapter.rest/adapter.rest.v2/src/main/webapp/swagger/index.html` to `http://tomcatHost:tomcatPort/sss.adapter.rest.v2/api-docs`
130
-
* (deprecated) for apiVersion `v1`
131
-
* adapt `swagger-maven-plugin` in `adapter/adapter.rest/adapter.rest.v1/pom.xml`
132
-
* property `basePath` to `http://tomcatHost:tomcatPort/sss.adapter.rest.v1/SSAdapterRest`
133
-
* property `swaggerUIDocBasePath` to `http://tomcatHost:tomcatPort/sss.adapter.rest.v1/api-docs`
134
-
* adapt swagger property `url` of object `SwaggerUi` in `adapter/adapter.rest/adapter.rest.v1/src/main/webapp/swagger/index.html` to `http://tomcatHost:tomcatPort/sss.adapter.rest.v1/api-docs`
* download [SSS Client Side](https://github.com/learning-layers/SocialSemanticServerClientSide/) libs to use with SSS API version 1
144
-
* link Javascript projects `JSUtilities`, `SSClientInterfaceGlobals` and `SSSClientInterfaceREST` in your application to have access to SSS server-side operations via its REST interface
145
-
146
-
## (deprecated) SSS plain REST API V1 access
147
-
* access the REST APIs via POST requests to `http://{your-sss-host}:{your-port}/sss.adapter.rest.v1/{API}/{yourOp}/`
148
-
*`your-sss-host` and `your-port` represents the host and port running the REST APIs
149
-
*`API` stands for the name of the REST API to be targeted:
150
-
*`SSAdapterRest` for all REST operations except for file handling
151
-
*`SSAdapterRESTFile` for REST operations dealing with files not using any multipart form parameters as input
152
-
*`SSAdapterRESTFileDownload` for REST operations dealing with file downloading
153
-
*`SSAdapterRESTFileUpload` for REST operations dealing with file uploading
154
-
*`SSAdapterRESTFileReplace` for REST operations dealing with file replacing
155
-
*`yourOp` represents the operation out of the ones provided by SSS (see documentation section and / or client-side SSS JS project)
156
-
* generally JSON strings are expected as input (mime type `application/json`)
157
-
* return values are JSON strings (except for, e.g. file downloading), e.g. `{"op":"collWithEntries", "error":false, "errorMsg":null, "opValue":{"author":"http://dt.ll/user/hugo/",...}}")`
158
-
* additionally, all properties/variables returned by any API call will contain a JSON-LD description
159
-
* following key-value pairs are returned (except for non-JSON returns) normally beside the actual return value described in the server-side REST API documentation
160
-
*`op` the operation returning the result
161
-
*`"opValue"` opValue will always be replaced by the op value provided for the op parameter and contains the actual result for the API request - the value of the operation's return
162
-
*`error` whether an error occured server-side
163
-
*`errorMsg` if error, "errorMsg" gets set to respective exception messages thrown
164
-
*`errorClassNames` if error, class names of errors
165
-
*`errorClassesWhereThrown` if error, class names where the errors got thrown
166
-
*`errorMethodsWhereThrown` if error, method names where the errors got thrown
167
-
*`errorLinesWhereThrown` if error, line numbers where the errors got thrown
168
-
*`errorThreadsWhereThrown` if error, id's of threads where the errors got thrown
169
134
170
135
## References
171
136
* D. Kowald, S. Dennerlein, D. Theiler, S. Walk and C. Trattner.: [The Social Semantic Server - A Framework to Provide Services on Social Semantic Network Data](http://ceur-ws.org/Vol-1026/paper11.pdf), 2013. In S. Lohmann (ed.), I-SEMANTICS (Posters & Demos) (p./pp. 50-54), : CEUR-WS.org.
0 commit comments