Common Data Service Server API¶
This page provides a static view of the methods in the CDS server. Please note that a running CDS server provides a more useful version of this information. View the details at a URL like the following, but check the server configuration for the exact port number (e.g., “8000”) and context root (e.g., “ccds”) to use:
http://localhost:8000/ccds/swagger-ui.html
CDS API in Athena Release¶
This lists the methods in version 1.18.4, which is part of the Athena release.
code-table-controller¶
GET /code/artifact/type
Gets the list of artifact type codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/notifmech
Gets the list of notification delivery mechanism codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/msgsev
Gets the list of message severity codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/deploy/status
Gets the list of deployment status codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/pair/{name}
Gets the list of code-name pairs for the specified value set. Returns bad request if the value set is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
name | path | name | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /code/model/type
Gets the list of model type codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/toolkit/type
Gets the list of toolkit type codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/access/type
Gets the list of access type codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/peer/status
Gets the list of peer status codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/step/status
Gets the list of step status codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/logprov
Gets the list of login provider codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/val/type
Gets the list of validation type codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/step/type
Gets the list of step type codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/sub/type
Gets the list of subscription scope codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/val/status
Gets the list of validation status codes. This is DEPRECATED, use getCodeNamePairs with the appropriate value-set name.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/pair
Gets the list of value set names that can be used to fetch code-name pairs.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
healthcheck-controller¶
GET /healthcheck
Assesses the health of the application by querying the database.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /version
Gets the value of the MANIFEST.MF property Implementation-Version as written by maven.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
peer-controller¶
POST /peer/sub
Creates a new entity with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerSub | body | peerSub |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /peer/{peerId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
peer | body | peer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /peer/{peerId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /peer/{peerId}
Gets the entity for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /peer/{peerId}/sub
Gets all subscriptions for the specified peer.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /peer
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peer | body | peer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /peer
Gets a page of peers, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /peer/sub/{subId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
subId | path | subId | integer |
peerSub | body | peerSub |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /peer/sub/{subId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
subId | path | subId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /peer/sub/{subId}
Gets the peer subscription for the specified ID.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
subId | path | subId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /peer/search
Searches for peers with attributes matching the values specified as query parameters. Defaults to match all (conjunction); send junction query parameter ‘_j=o’ to match any (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
name | query | Name | string |
subjectName | query | Subject name | string |
apiUrl | query | API URL | string |
webUrl | query | Web URL | string |
isSelf | query | isSelf | boolean |
isLocal | query | isLocal | boolean |
contact1 | query | Contact 1 | string |
statusCode | query | Status code | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
step-result-controller¶
PUT /stepresult/{stepResultId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResultId | path | stepResultId | integer |
stepResult | body | stepResult |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /stepresult/{stepResultId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResultId | path | stepResultId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /stepresult/{stepResultId}
Gets the step result for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResultId | path | stepResultId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /stepresult/search
Searches for requests with attributes matching the values specified as query parameters. Defaults to match all (conjunction); send junction query parameter ‘_j=o’ to match any (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
trackingId | query | Tracking ID | string |
stepCode | query | Step code | string |
solutionId | query | Solution ID | string |
revisionId | query | Revision ID | string |
artifiactId | query | Artifact ID | string |
userId | query | User ID | string |
name | query | Name | string |
statusCode | query | Status code | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /stepresult
Creates a new entity with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResult | body | stepResult |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /stepresult
Gets a page of step results, optionally sorted on fields.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
notification-controller¶
GET /notif/notifpref/user/{userId}
Gets notification preferences for the specified user ID.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif/user/{userId}
Gets active notifications for the specified user ID.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /notif
Creates a new notification and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notif | body | notif |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /notif
Gets a page of notifications, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif/count
Gets the count of notifications.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /notif/{notificationId}
Updates an existing notification with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notificationId | path | notificationId | string |
notif | body | notif |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /notif/{notificationId}
Deletes the notification with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notificationId | path | notificationId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
PUT /notif/notifpref/{userNotifPrefId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userNotifPrefId | path | userNotifPrefId | integer |
usrNotifPref | body | usrNotifPref |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /notif/notifpref/{userNotifPrefId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userNotifPrefId | path | userNotifPrefId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /notif/notifpref/{userNotifPrefId}
Gets the user notification preference for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userNotifPrefId | path | userNotifPrefId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /notif/{notificationId}/user/{userId}
Records the date when the user viewed the notification in the notification-user mapping table. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
notificationId | path | notificationId | string |
notifUserMap | body | notifUserMap |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /notif/{notificationId}/user/{userId}
Adds a user as a recipient of the notification. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
notificationId | path | notificationId | string |
notifUserMap | body | notifUserMap |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /notif/{notificationId}/user/{userId}
Drops a user as a recipient of the notification.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
notificationId | path | notificationId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
POST /notif/notifpref
Creates a new user notification preference. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
usrNotifPref | body | usrNotifPref |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
solution-controller¶
DELETE /solution/{solutionId}/dnld/{downloadId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
downloadId | path | downloadId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/count
Gets the count of solutions.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{parentId}/comp
Gets a list of child solution IDs used in the specified composite solution.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
parentId | path | parentId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/revision/{revisionId}/deploy
Creates a new deployment record for the specified solution and revision. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
sd | body | sd |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision/{revisionId}/deploy
Gets the deployments for the specified solution and revision IDs. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/search/user
Finds user-accessible solutions matching the specified attribute values. Keywords are processed using LIKE-operator search. Does not search any child entities.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
user | query | User ID | string |
atc | query | Access type codes | array |
mtc | query | Model type codes | array |
vsc | query | Validation status codes (deprecated) | array |
name | query | Name key words | array |
desc | query | Description key words | array |
tag | query | Tags | array |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/portal/kw
Finds solutions matching the specified attribute values and/or child attribute values. Checks multiple fields for the supplied keywords, including ID, name, description etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
atc | query | Access type codes | array |
mtc | query | Model type codes | array |
kw | query | Key words | array |
user | query | User IDs | array |
tag | query | Tags | array |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{solutionId}/web
Gets web metadata for the specified solution including average rating and total download count. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision/{revisionId}/user/{userId}/deploy
Gets the deployments for the specified solution, revision and user IDs. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
userId | path | userId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /solution/{solutionId}/view
Increments the view count of the specified solution (special case of update). Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
deploymentId | path | deploymentId | string |
sd | body | sd |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
deploymentId | path | deploymentId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
POST /solution
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solution | body | solution |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution
Gets a page of solutions, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/date
Finds solutions based on specified date, active status and access type query parameters. Limits result to solutions modified after the specified time, expressed in milliseconds since the Epoch.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
datems | query | Milliseconds since the Epoch | integer |
active | query | Active Y/N | boolean |
atc | query | Access type codes | array |
vsc | query | Validation status codes (deprecated) | array |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{parentId}/comp/{childId}
Adds a child to the parent composite solution. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
parentId | path | parentId | string |
childId | path | childId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{parentId}/comp/{childId}
Drops a child from the parent composite solution. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
parentId | path | parentId | string |
childId | path | childId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
PUT /solution/{solutionId}/revision/{revisionId}/validation/{taskId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
taskId | path | taskId | string |
sv | body | sv |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /solution/{solutionId}/revision/{revisionId}/validation/{taskId}
Creates a new solution validation record. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
taskId | path | taskId | string |
sv | body | sv |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/revision/{revisionId}/validation/{taskId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
taskId | path | taskId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/user/{userId}/access
Gets a page of solutions with the specified user in the ACL, optionally sorted on fields.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{solutionId}/tag
Gets a list of tags for the specified solution.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/dnld/artifact/{artifactId}/user/{userId}
Creates a new solution download record. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
artifactId | path | artifactId | string |
sd | body | sd |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/search/like
Searches for entities with names or descriptions that contain the search term using the like operator.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
term | query | term | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/revision
Creates a new solution revision and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revision | body | revision |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision
Gets a list of revisions for the specified solution IDs.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{solutionId}/revision/{revisionId}/validation
Gets validation results for the specified solution and revision. Returns bad request if an ID is not found
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/rating
Gets all user ratings for the specified solution. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/search/portal
Finds solutions with attribute values and/or child attribute values matching the field name - field value pairs specified as query parameters. Supports faceted search; i.e., check for kw1 in name, kw2 in description and so on.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
atc | query | Access type codes | array |
mtc | query | Model type codes | array |
vsc | query | Validation status codes (deprecated) | array |
user | query | User IDs | array |
tag | query | Tags | array |
name | query | Name key words | array |
desc | query | Description key words | array |
auth | query | Author key words | array |
pub | query | Publisher key words | array |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/portal/kwtag
Finds solutions matching the specified attribute values and/or child attribute values with flexible handling of tags to allow all/any matches. Checks multiple fields for the supplied keywords, including ID, name, description etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
atc | query | Access type codes | array |
mtc | query | Model type codes | array |
kw | query | Key words | array |
user | query | User IDs | array |
alltag | query | All tags, solution must have every one | array |
anytag | query | Any tags, solution must have at least one | array |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
solution | body | solution |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}
Deletes the solution with the specified ID. Cascades the delete to related entities. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}
Gets the solution for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /solution/{solutionId}/rating/user/{userId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
sr | body | sr |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /solution/{solutionId}/rating/user/{userId}
Creates a new solution rating. Returns bad request on constrain violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
sr | body | sr |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /solution/{solutionId}/rating/user/{userId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/rating/user/{userId}
Gets an existing solution rating. Returns bad request if the ID is not found
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/dnld
Gets a page of download records for the specified solution ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /solution/{solutionId}/tag/{tag}
Adds a tag to the solution. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
tag | path | tag | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/tag/{tag}
Drops a tag from the solution. Returns bad request if not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
tag | path | tag | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/user/access
Gets access-control list of users for the specified solution.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/tag
Gets a page of solutions matching the specified tag.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
tag | query | tag | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/user/{userId}/access
Adds a user to the ACL for the specified solution. Returns bad request if an ID is not found
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/user/{userId}/access
Drops a user from the ACL for the specified solution. Returns bad request if an ID is not found
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
PUT /solution/{solutionId}/revision/{revisionId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
revision | body | revision |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/revision/{revisionId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision/{revisionId}
Gets the revision for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/search
Searches for peers with attributes matching the values specified as query parameters. Defaults to match all (conjunction); send junction query parameter ‘_j=o’ to match any (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
name | query | Name | string |
active | query | Active | boolean |
userId | query | User ID | string |
sourceId | query | Source ID | string |
modelTypeCode | query | Model type code | string |
toolkitTypeCode | query | Toolkit type code | string |
origin | query | Origin URI | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
publish-request-controller¶
PUT /pubreq/{requestId}
Updates an existing request with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
requestId | path | requestId | integer |
publishRequest | body | publishRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /pubreq/{requestId}
Deletes the request with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
requestId | path | requestId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /pubreq/{requestId}
Gets the request for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
requestId | path | requestId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /pubreq
Creates a new request with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
publishRequest | body | publishRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /pubreq
Gets a page of publish requests, optionally sorted on fields.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /pubreq/search
Searches for requests with attributes matching the values specified as query parameters. Defaults to match all (conjunction); send junction query parameter ‘_j=o’ to match any (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
solutionId | query | Solution ID | string |
revisionId | query | Revision ID | string |
requestUserId | query | Request user ID | string |
reviewUserId | query | Review user ID | string |
statusCode | query | Status code | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
group-peer-solution-controller¶
GET /group/peer/{peerId}/solution/{solutionId}/access
Checks access for the specified peer to the specified solution.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /group/peer/{principalGroupId}/peer/{resourceGroupId}
Grants access for the specified principal peer group to the specified resource peer group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
principalGroupId | path | principalGroupId | integer |
resourceGroupId | path | resourceGroupId | integer |
map | body | map |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /group/peer/{principalGroupId}/peer/{resourceGroupId}
Removes access for the specified principal peer group to the specified resource peer group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
principalGroupId | path | principalGroupId | integer |
resourceGroupId | path | resourceGroupId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /group/peer/solution
Gets a page of peer-solution membership mappings, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /group/{groupId}/peer/{peerId}
Adds the specified peer as a member of the specified peer group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
peerId | path | peerId | string |
map | body | map |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /group/{groupId}/peer/{peerId}
Drops the specified peer as a member of the specified peer group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
peerId | path | peerId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
PUT /group/{groupId}/solution
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
group | body | group |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /group/{groupId}/solution
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /group/{groupId}/solution
Gets a page of solution members in the specified solution group, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /group/{groupId}/peer
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
group | body | group |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /group/{groupId}/peer
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /group/{groupId}/peer
Gets a page of peer members of the specified peer group, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /group/peer/{peerGroupId}/solution/{solutionGroupId}
Grants access for the specified peer group to the specified solution group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerGroupId | path | peerGroupId | integer |
solutionGroupId | path | solutionGroupId | integer |
map | body | map |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /group/peer/{peerGroupId}/solution/{solutionGroupId}
Removes access for the specified peer group to the specified solution group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerGroupId | path | peerGroupId | integer |
solutionGroupId | path | solutionGroupId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /group/peer/{peerId}/access
Gets peers accessible to the specified peer.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /group/peer
Creates a new entity with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
group | body | group |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /group/peer
Gets a page of peer groups, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /group/{groupId}/solution/{solutionId}
Adds the specified solution as a member of the specified solution group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
solutionId | path | solutionId | string |
map | body | map |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /group/{groupId}/solution/{solutionId}
Drops the specified solution as a member of the specified solution group.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
groupId | path | groupId | integer |
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
POST /group/solution
Creates a new entity with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
group | body | group |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /group/solution
Gets a page of solution groups, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /group/peer/{peerId}/solution
Gets a page of non-public solutions accessible to specified peer
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
document-controller¶
PUT /document/{documentId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
documentId | path | documentId | string |
document | body | document |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /document/{documentId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
documentId | path | documentId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /document/{documentId}
Gets the entity for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
documentId | path | documentId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /document
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
document | body | document |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
artifact-controller¶
GET /artifact/like
Searches for entities with names or descriptions that contain the search term using the like operator.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
term | query | term | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /artifact/{artifactId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
artifact | body | artifact |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /artifact/{artifactId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /artifact/{artifactId}
Gets the entity for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /artifact/count
Gets the count of artifacts.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /artifact/{artifactId}/revision
Gets the solution revisions that use the specified artifact ID.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /artifact
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifact | body | artifact |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /artifact
Gets a page of artifacts, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /artifact/search
Searches for artifacts with attributes matching the values specified as query parameters. Defaults to match all (conjunction); send junction query parameter ‘_j=o’ to match any (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
artifactTypeCode | query | Artifact type code | string |
name | query | Name | string |
uri | query | URI | string |
version | query | Version | string |
userId | query | User ID | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
thread-controller¶
GET /thread/solution/{solutionId}/revision/{revisionId}/count
Gets the count of threads for the solution and revision IDs.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /thread
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
thread | body | thread |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /thread
Gets a page of threads, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/count
Gets the count of threads.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/solution/{solutionId}/revision/{revisionId}/comment/count
Gets comment count for the solution revision.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /thread/{threadId}/comment
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
comment | body | comment |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /thread/{threadId}/comment
Gets a page of comments in the thread.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /thread/{threadId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
thread | body | thread |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /thread/{threadId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /thread/{threadId}
Gets the thread for the specified ID. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /thread/solution/{solutionId}/revision/{revisionId}
Gets a page of threads for the solution and revision IDs, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/{threadId}/comment/count
Gets the number of comments in the thread.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/solution/{solutionId}/revision/{revisionId}/comment
Gets a page of comments for the solution revision, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
revisionId | path | revisionId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /thread/{threadId}/comment/{commentId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
commentId | path | commentId | string |
comment | body | comment |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /thread/{threadId}/comment/{commentId}
Deletes the entity with the specified ID. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
commentId | path | commentId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /thread/{threadId}/comment/{commentId}
Gets the comment for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
threadId | path | threadId | string |
commentId | path | commentId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
dataset-controller¶
GET /dataset/{datasetId}
Gets the dataset for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
datasetId | path | datasetId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
role-controller¶
POST /role/{roleId}/function
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
roleFunction | body | roleFunction |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /role/{roleId}/function
Gets the functions for the specified role. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /role/{roleId}/function/{functionId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
functionId | path | functionId | string |
roleFunction | body | roleFunction |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /role/{roleId}/function/{functionId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
functionId | path | functionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /role/{roleId}/function/{functionId}
Gets the role function for the specified role and function IDs. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
functionId | path | functionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /role/search
Searches for roles with attributes matching the values specified as query parameters. Defaults to match all (conjunction); send junction query parameter ‘_j=o’ to match any (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
name | query | Name | string |
active | query | Active | boolean |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /role/count
Gets the count of roles.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /role/{roleId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
role | body | role |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /role/{roleId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /role/{roleId}
Gets the entity for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /role
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
role | body | role |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /role
Gets a page of roles, optionally sorted on fields.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
tag-controller¶
DELETE /tag/{tag}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
tag | path | tag | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
POST /tag
Creates a new tag. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
tag | body | tag |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /tag
Gets a page of tags, optionally sorted.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
validation-sequence-controller¶
POST /valseq/{sequence}/valtype/{valTypeCode}
Creates a new validation sequence record.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
sequence | path | sequence | integer |
valTypeCode | path | valTypeCode | string |
valSeq | body | valSeq |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /valseq/{sequence}/valtype/{valTypeCode}
Deletes the specified validation sequence record.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
sequence | path | sequence | integer |
valTypeCode | path | valTypeCode | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /valseq
Gets the list of validation sequence records.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
user-controller¶
PUT /user/role/{roleId}
Adds or removes the specified role for multiple users. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
usersRoleRequest | body | usersRoleRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /user/count
Gets the count of users.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /user/login
Checks the specified credentials for full access. Searches both login name and email fields for the specified name. Returns the user object if an active user exists with the specified credentials; returns bad request if no match is found. Imposes a delay on repeated failures.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
login | body | login |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /user
Creates a new entity and generates an ID if needed. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
user | body | user |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /user
Gets a page of users, optionally sorted on fields.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user/like
Searches for users with names that contain the search term using a like operator.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
term | query | term | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
user | body | user |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}
Deletes the entity with the specified ID. Cascades to related entities. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/{userId}
Gets the user for the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /user/{userId}/favorite/solution
Gets a page of solutions which are favorites for the specified user ID.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
ulp | body | ulp |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Creates a new entity. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
ulp | body | ulp |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Gets the login provider for the specified user, provider code and provider login. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /user/verify
Checks the specified credentials for verification. Searches both login name and email fields for the specified name. Returns the user object if an active user exists with the specified credentials; returns bad request if no match is found. Imposes a delay on repeated failures.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
login | body | login |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /user/{userId}/role/{roleId}
Adds a role to the user. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
roleId | path | roleId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/role/{roleId}
Drops a role from the user. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
roleId | path | roleId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/role/{roleId}/count
Gets the count of users in a role.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}/chgpw
Changes the user’s password to the new value if the user exists, is active, and the old password matches. Returns bad request if not found or not matched.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
changeRequest | body | changeRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /user/{userId}/logprov
Gets all login providers for the specified user.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}/role
Assigns the specified roles to the user after dropping any existing assignments. Returns bad request if an Id is not found
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
roleIds | body | roleIds |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /user/{userId}/role
Gets all roles assigned to the specified user ID.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user/search
Searches for users with attributes matching the values specified as query parameters. Defaults to match all (conjunction); send junction query parameter ‘_j=o’ to match any (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
firstName | query | First name | string |
middleName | query | Middle name | string |
lastName | query | Last name | string |
orgName | query | Org name | string |
query | string | ||
loginName | query | Login name | string |
active | query | Active | boolean |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /user/{userId}/tag/{tag}
Adds a tag to the user. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
tag | path | tag | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/tag/{tag}
Drops a tag from the user. Returns bad request if not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
tag | path | tag | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/{userId}/deploy
Gets the deployments for the specified user ID.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
page | query | Results page you want to retrieve (0..N) | integer |
size | query | Number of records per page. | integer |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /user/{userId}/favorite/solution/{solutionId}
Creates a new solution favorite record. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
sfv | body | sfv |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/favorite/solution/{solutionId}
Deletes the entity with the specified IDs. Returns bad request if the entity is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
POST /user/loginapi
Checks the specified credentials for API access. Searches both login name and email fields for the specified name. Returns the user object if an active user exists with the specified credentials; returns bad request if no match is found. Imposes a delay on repeated failures.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
login | body | login |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
site-config-controller¶
POST /config
Creates a new site configuration record. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
siteConfig | body | siteConfig |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /config/{configKey}
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
configKey | path | configKey | string |
siteConfig | body | siteConfig |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /config/{configKey}
Deletes the entity with the specified key. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
configKey | path | configKey | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /config/{configKey}
Gets the site configuration value for the specified key.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
configKey | path | configKey | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
revision-controller¶
GET /revision/{revisionId}/artifact
Gets the artifacts for the revision.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /revision/{revisionId}/access/{accessTypeCode}/descr
Updates an existing entity with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
accessTypeCode | path | accessTypeCode | string |
description | body | description |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /revision/{revisionId}/access/{accessTypeCode}/descr
Creates a new description for the specified revision and access type. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
accessTypeCode | path | accessTypeCode | string |
description | body | description |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /revision/{revisionId}/access/{accessTypeCode}/descr
Deletes the entity with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
accessTypeCode | path | accessTypeCode | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /revision/{revisionId}/access/{accessTypeCode}/descr
Gets the revision description for the specified access type. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
accessTypeCode | path | accessTypeCode | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /revision/{revisionId}/access/{accessTypeCode}/document
Gets the documents for the specified revision and access type.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
accessTypeCode | path | accessTypeCode | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /revision/{revisionId}/artifact/{artifactId}
Adds an artifact to the revision.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
artifactId | path | artifactId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /revision/{revisionId}/artifact/{artifactId}
Removes an artifact from the revision.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
artifactId | path | artifactId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
POST /revision/{revisionId}/access/{accessTypeCode}/document/{documentId}
Adds a user document to the specified revision and access type.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
accessTypeCode | path | accessTypeCode | string |
documentId | path | documentId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /revision/{revisionId}/access/{accessTypeCode}/document/{documentId}
Removes a user document from the specified revision and access type.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
accessTypeCode | path | accessTypeCode | string |
documentId | path | documentId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized