S-CASE Asset Registry REST API

Description of S-CASE Asset Registry REST API
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.8
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

  1. post /artefact
  2. delete /artefact/{id}
  3. get /artefact/exists/{id}
  4. get /artefact/{id}
  5. get /artefact/directsearch
  6. get /artefact/search
  7. put /artefact/{id}
  8. get /domain/{id}
  9. get /domain/domains
  10. post /project
  11. delete /project/{id}
  12. delete /project/{name}
  13. get /project/{id}
  14. get /project/{name}
  15. get /project/directsearch
  16. get /project/search
  17. put /project/{id}
  18. get /subdomain/{id}
  19. get /subdomain/subdomains
  20. get /version
Up 
post /artefact
Creates and stores a new artefact in the repository (create)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Artefact to be stored in the Asset Repo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content (artefact has been created successfully)

400

Request incorrect

404

Not found

500

Internal Server error
Up 
delete /artefact/{id}
Deletes an artefact from the repository (delete)

Path parameters

id (required)
Path Parameter — Artefact ID of the artefact that shall be deleted from the Asset Repo

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /artefact/exists/{id}
Checks if an artefact does exist in the repository (exists)

Path parameters

id (required)
Path Parameter — Artefact ID

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Boolean

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server errorm
Up 
get /artefact/{id}
Finds an artefact in the repository by ID (get)

Path parameters

id (required)
Path Parameter — Artefact ID

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

JsonArtefact

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /artefact/directsearch
Finds a list of artefacts by search query. <BR>The search query has to be submitted in the Elastic Search JSON search syntax. (searchArtefacts)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

q (optional)
Query Parameter — Search query in the Elastic Search JSON syntax

Return type

array[ArtefactDTO]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /artefact/search
Finds a list of artefacts by free text search strings. <BR>All query parameters are optional and can be combined as needed but at least one parameter has to be submitted. (searchArtefacts_1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

query (optional)
Query Parameter — Free text string that should be used to search inside of an artefact
domain (optional)
Query Parameter — Domain name string an artefact should be assigned to
subdomain (optional)
Query Parameter — Subdomain name string an artefact should be assigned to
type (optional)
Query Parameter — The Artefact Type of an artefact (e.g. USE_CASE)

Return type

array[ArtefactDTO]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
put /artefact/{id}
Updates an artefact in the repository (update)

Path parameters

id (required)
Path Parameter — artefact id

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The artefact to be updated

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /domain/{id}
Finds a domain by ID in the repository (find)

Path parameters

id (required)
Path Parameter — domain id

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Domain

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /domain/domains
Retrieves a list of all domains in the repository (findAll)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[Domain]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
post /project
Creates and stores a new project in the repository (create)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The project to be stored inside of the Asset Repo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content (project has been created successfully)

400

Request incorrect

404

Not found

500

Internal Server error
Up 
delete /project/{id}
Deletes a project from the Asset Repo by ID (delete)

Path parameters

id (required)
Path Parameter — ID of the project to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
delete /project/{name}
Deletes a project from the Asset Repo by name (delete_1)

Path parameters

name (required)
Path Parameter — name of the project to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /project/{id}
Finds a project in the repository by ID (get)

Path parameters

id (required)
Path Parameter — project ID

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

JsonProject

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /project/{name}
Finds a project in the repository by its name (get_2)

Path parameters

name (required)
Path Parameter — the name of the project

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

JsonProject

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /project/directsearch
Finds a list of projects in the repository by search query. <BR>The search query has to be submitted in the Elastic Search JSON search syntax. (searchProjects)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

q (optional)
Query Parameter — Search query in the Elastic Search JSON syntax

Return type

array[ProjectDTO]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /project/search
Finds a list of projects by free text search strings. <BR> All query parameters are optional and can be combined as needed but at least one parameter has to be submitted. (searchProjects_3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

query (optional)
Query Parameter — Free text string that should be used to search inside of a project
domain (optional)
Query Parameter — Domain name string a project should be assigned to
subdomain (optional)
Query Parameter — Subdomain name string a project should be assigned to

Return type

array[ProjectDTO]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
put /project/{id}
Updates a project in the Asset Repo (update)

Path parameters

id (required)
Path Parameter — Project ID

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The project to be updated inside of the Asset Repo

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /subdomain/{id}
Finds a subdomain by ID in the Asset Repository (find)

Path parameters

id (required)
Path Parameter — subdomain ID

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

SubDomain

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /subdomain/subdomains
Retrieves a list of all subdomains in the Asset Repository (findAll)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[SubDomain]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up 
get /version
Returns the version number (version)

Return type

String

Responses

200

successful operation

204

No content

400

Request incorrect

404

Not found

500

Internal Server error
Up

Models

[ Jump to Methods ]

Table of Contents

  1. ArtefactDTO
  2. Domain
  3. JsonArtefact
  4. JsonArtefactPayload
  5. JsonProject
  6. ProjectDTO
  7. SubDomain

ArtefactDTO Up

artefact
JsonArtefact
score
Float

Domain Up

id
Long
version
Long
name
String
subdomains
array[SubDomain]

JsonArtefact Up

id
Long
createdBy
String
updatedBy
String
createdAt
Date
updatedAt
Date
domain
String
subDomain
String
privacyLevel
String
Enum:
PUBLIC
PRIVATE
version
Long
projectName
String
uri
String
groupId
String
name
String
dependencies
array[Long]
type
String
Enum:
USE_CASE
ACTIVITY_DIAGRAM
ANALYSIS_CLASS_DIAGRAM
STORYBOARD
TEXTUAL
STATIC_ONTOLOGY
DYNAMIC_ONTOLOGY
AGGREGATED_ONTOLOGY
CODE_SNIPPET
NOTE
CIM
PIM
PSM
CODE
SERVICE_DESCRIPTION
COMPOSITE_SERVICE_DESCRIPTION
SERVICE
OSRF_PROJECT
OSRF_FILE
description
String
tags
array[String]
metadata
map[String, String]
payload
array[JsonArtefactPayload]

JsonArtefactPayload Up

id
Long
version
Long
type
String
Enum:
BINARY
TEXTUAL
format
String
Enum:
IMAGE
XMI
TEXT_ISO_639_3
TEXT_UTF8
OWL
N3
RDF
JAVA_CODE
JAVA_CODE_PACKED
JSON
WADL
XML
name
String
payload
array[byte[]]

JsonProject Up

id
Long
createdBy
String
updatedBy
String
createdAt
Date
updatedAt
Date
domain
String
subDomain
String
privacyLevel
String
Enum:
PUBLIC
PRIVATE
version
Long
name
String
artefacts
array[JsonArtefact]

ProjectDTO Up

project
JsonProject
score
Float

SubDomain Up

id
Long
version
Long
name
String
domain
Domain