Description of S-CASE Asset Registry REST API
| Path | Method | Description |
|---|---|---|
| /artefact | POST | Creates and stores a new artefact in the repository |
| /artefact/directsearch | GET | Finds a list of artefacts by search query |
| /artefact/exists/{id} | GET | Checks whether an artefact exists in the repository |
| /artefact/search | GET | Finds a list of artefacts by free text search strings |
| /artefact/{id} | DELETE | Deletes an artefact from the repository |
| GET | Finds an artefact in the repository by ID | |
| PUT | Updates an artefact in the repository | |
| /domain/domains | GET | Retrieves a list of all domains in the repository |
| /domain/{id} | GET | Finds a domain by ID in the repository |
| /project | POST | Creates and stores a new project in the repository |
| /project/directsearch | GET | Finds a list of projects in the repository by search query |
| /project/search | GET | Finds a list of projects by free text search strings |
| /project/{id} | DELETE | Deletes a project from the Asset Repo by ID |
| PUT | Updates a project in the Asset Repo | |
| /project/{id}/id | GET | Finds a project in the repository by ID |
| /project/{name} | DELETE | Deletes a project from the Asset Repo by name |
| /project/{name}/name | GET | Finds a project in the repository by its name |
| /subdomain/subdomains | GET | Retrieves a list of all subdomains in the Asset Repository |
| /subdomain/{id} | GET | Finds a subdomain by ID in the Asset Repository |
| /version | GET | Returns the version number |
application/json
Artefact to be stored in the Asset Repo
application/json;charset=UTF-8
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| q | Elastic Search query string | query | string |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| id | Artefact ID | path | integer (int64) |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| query | Elastic Search query string | query | string |
| domain | Elastic Search domain | query | string |
| subdomain | Elastic Search subdomain | query | string |
| type | artefact type | query | string |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| id | Artefact ID of the artefact that shall be deleted from the Asset Repo | path | integer (int64) |
application/json;charset=UTF-8
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| id | Artefact ID | path | integer (int64) |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
The artefact to be updated
| id | artefact id | path | integer (int64) |
application/json;charset=UTF-8
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| id | domain id | path | integer (int64) |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
The project to be stored inside of the Asset Repo
application/json;charset=UTF-8
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| q | search query | query | string |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| query | Elastic Search query string | query | string |
| domain | Elastic Search domain | query | string |
| subdomain | Elastic Search subdomain | query | string |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| id | ID of the project to be deleted | path | integer (int64) |
application/json;charset=UTF-8
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
The project to be updated inside of the Asset Repo
| id | Project ID | path | integer (int64) |
application/json;charset=UTF-8
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| id | project ID | path | integer (int64) |
application/json;charset=UTF-8
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| name | name of the project to be deleted | path | string |
application/json;charset=UTF-8
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| name | the name of the project | path | string |
application/json;charset=UTF-8
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
application/json
| id | subdomain ID | path | integer (int64) |
application/json
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|
| 200 |
successful operation
|
| 204 |
No content
|
| 400 |
Request incorrect
|
| 401 |
Unauthorized
|
| 403 |
Forbidden
|
| 404 |
Not found
|
| 500 |
Server problem
|