Example of Rendered Content From api-docs.json File¶
code-table-controller¶
GET /code/artifact/type
Gets the list of artifact type codes.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/msgsev
Gets the list of message severity codes.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| name | path | name | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/model/type
Gets the list of model type codes.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/logprov
Gets the list of login provider codes.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /code/pair
Gets the list of value set names.
- Produces: [u’*/*’]
- 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 peer subscription.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| peerSub | body | peerSub |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /peer/{peerId}
Updates a peer.
- Produces: [u’*/*’]
- 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
DELETE /peer/{peerId}
Deletes a peer.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| peerId | path | peerId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /peer/{peerId}
Gets the peer for the specified ID.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /peer/{peerId}/sub
Gets all subscriptions for the specified peer.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /peer
Creates a new peer.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| peer | body | peer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /peer
Gets a page of peers, optionally sorted on fields.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /peer/sub/{subId}
Updates a peer subscription.
- Produces: [u’*/*’]
- 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
DELETE /peer/sub/{subId}
Deletes a peer subscription.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| subId | path | subId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /peer/sub/{subId}
Gets the peer subscription for the specified ID.
- Produces: [u’*/*’]
- 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 using the field name - field value pairs specified as query parameters. Defaults to and (conjunction); send junction query parameter = o for or (disjunction).
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
step-result-controller¶
PUT /stepresult/{stepResultId}
Updates a step result.
- 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
DELETE /stepresult/{stepResultId}
Deletes the stepResult with the specified ID.
- 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
GET /stepresult/{stepResultId}
Gets the step result for the specified ID.
- 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
GET /stepresult/search
Searches for step results using the field name - field value pairs specified as query parameters. Defaults to and (conjunction); send junction query parameter = o for or (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /stepresult
Creates a new step result.
- 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
GET /stepresult
Gets a page of step results, optionally sorted on fields.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
notification-controller¶
POST /notif
Creates a new notification.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| notif | body | notif |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif
Gets a page of notifications, optionally sorted.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif/count
Gets the count of notifications.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /notif/{notificationId}
Updates a notification.
- Produces: [u’*/*’]
- 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
DELETE /notif/{notificationId}
Deletes a notification.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| notificationId | path | notificationId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
solution-controller¶
DELETE /solution/{solutionId}/dnld/{downloadId}
Deletes the specified solution download record.
- Produces: [u’*/*’]
- 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
GET /solution/count
Gets the count of solutions.
- Produces: [u’*/*’]
- 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’*/*’]
- 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.
- Produces: [u’*/*’]
- 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
GET /solution/{solutionId}/revision/{revisionId}/deploy
Gets the deployments for the specified solution and revision IDs.
- Produces: [u’*/*’]
- 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
GET /solution/search/user
Gets a page of user-accessible solutions
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/revision/{revisionId}/artifact/{artifactId}
Adds an artifact to the solution revision.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| solutionId | path | solutionId | string |
| revisionId | path | revisionId | string |
| artifactId | path | artifactId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /solution/{solutionId}/revision/{revisionId}/artifact/{artifactId}
Removes an artifact from the solution revision.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| solutionId | path | solutionId | string |
| revisionId | path | revisionId | string |
| artifactId | path | artifactId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /solution/{solutionId}/web
Gets web metadata for the specified solution including average rating and total download count.
- Produces: [u’*/*’]
- 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}/user/{userId}/deploy
Gets the deployments for the specified solution, revision and user IDs.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| solutionId | path | solutionId | string |
| revisionId | path | revisionId | string |
| userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Updates the deployment record for the specified ID.
- Produces: [u’*/*’]
- 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
DELETE /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Deletes the specified deployment record.
- Produces: [u’*/*’]
- 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
PUT /solution/{solutionId}/view
Increments view count of the specified solution.
- Produces: [u’*/*’]
- 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
POST /solution
Creates a new solution.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| solution | body | solution |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution
Gets a page of solutions, optionally sorted on fields.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/date
Gets a page of solutions modified after the specified time, expressed in milliseconds since the Epoch.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{parentId}/comp/{childId}
Adds a child to the parent composite solution.
- Produces: [u’*/*’]
- 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
DELETE /solution/{parentId}/comp/{childId}
Drops a child from the parent composite solution.
- Produces: [u’*/*’]
- 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
PUT /solution/{solutionId}/revision/{revisionId}/validation/{taskId}
Updates the specified solution validation.
- Produces: [u’*/*’]
- 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
POST /solution/{solutionId}/revision/{revisionId}/validation/{taskId}
Creates a new solution validation record.
- Produces: [u’*/*’]
- 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
DELETE /solution/{solutionId}/revision/{revisionId}/validation/{taskId}
Deletes the specified solution validation record.
- Produces: [u’*/*’]
- 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
GET /solution/user/{userId}/access
Gets a page of solutions with the specified user in the ACL, optionally sorted on fields.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| userId | path | userId | string |
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’*/*’]
- 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.
- Produces: [u’*/*’]
- 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
GET /solution/search/like
Searches for solutions with names or descriptions that contain the search term.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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
GET /solution/{solutionId}/revision
Gets a list of revisions for the specified solution IDs.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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
GET /solution/{solutionId}/rating
Gets all user ratings for the specified solution.
- Produces: [u’*/*’]
- 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/portal
Gets a page of solutions matching all criteria.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{solutionId}/revision/{revisionId}/artifact
Gets the artifacts for the solution revision.
- Produces: [u’*/*’]
- 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
PUT /solution/{solutionId}
Updates a solution.
- Produces: [u’*/*’]
- 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
DELETE /solution/{solutionId}
Deletes a solution.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /solution/{solutionId}
Gets the solution for the specified ID.
- Produces: [u’*/*’]
- 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}/dnld
Gets a page of download records for the specified solution ID.
- Produces: [u’*/*’]
- 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}/tag/{tag}
Adds a tag to the solution.
- Produces: [u’*/*’]
- 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
DELETE /solution/{solutionId}/tag/{tag}
Drops a tag from the solution.
- Produces: [u’*/*’]
- 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
GET /solution/{solutionId}/user/access
Gets access-control list of users for the specified solution.
- Produces: [u’*/*’]
- 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’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| tag | query | tag | string |
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.
- Produces: [u’*/*’]
- 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
DELETE /solution/{solutionId}/user/{userId}/access
Drops a user from the ACL for the specified solution.
- Produces: [u’*/*’]
- 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
PUT /solution/{solutionId}/revision/{revisionId}
Updates an existing solution revision.
- Produces: [u’*/*’]
- 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
DELETE /solution/{solutionId}/revision/{revisionId}
Deletes a solution revision.
- Produces: [u’*/*’]
- 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
GET /solution/{solutionId}/revision/{revisionId}
Gets the revision for the specified ID.
- Produces: [u’*/*’]
- 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
GET /solution/search
Searches for solutions using the field name - field value pairs specified as query parameters. Defaults to and (conjunction); send junction query parameter = o for or (disjunction). With no limit, defaults to size 20.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}/rating/user/{userId}
Updates the specified solution rating.
- Produces: [u’*/*’]
- 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
POST /solution/{solutionId}/rating/user/{userId}
Creates a new solution rating.
- Produces: [u’*/*’]
- 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 specified solution rating.
- Produces: [u’*/*’]
- 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
GET /solution/{solutionId}/rating/user/{userId}
Gets an existing solution rating.
- Produces: [u’*/*’]
- 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
group-peer-solution-controller¶
GET /group/peer/{peerId}/solution/{solutionId}/access
Checks access for the specified peer to the specified solution.
- Produces: [u’*/*’]
- 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
POST /group/peer/{principalGroupId}/peer/{resourceGroupId}
Grants access for the specified principal peer group to the specified resource peer group.
- Produces: [u’*/*’]
- 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
DELETE /group/peer/{principalGroupId}/peer/{resourceGroupId}
Removes access for the specified principal peer group to the specified resource peer group.
- Produces: [u’*/*’]
- 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
GET /group/peer/solution
Gets a page of peer-solution membership mappings, optionally sorted.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
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’*/*’]
- 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’*/*’]
- 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
PUT /group/{groupId}/solution
Updates a solution group.
- Produces: [u’*/*’]
- 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
DELETE /group/{groupId}/solution
Deletes a solution group.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| groupId | path | groupId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /group/{groupId}/solution
Gets a page of solution members in the specified solution group, optionally sorted.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| groupId | path | groupId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /group/{groupId}/peer
Updates a peer group.
- Produces: [u’*/*’]
- 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
DELETE /group/{groupId}/peer
Deletes a peer group.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| groupId | path | groupId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /group/{groupId}/peer
Gets a page of peer members of the specified peer group, optionally sorted.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| groupId | path | groupId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /group/peer/{peerGroupId}/solution/{solutionGroupId}
Grants access for the specified peer group to the specified solution group.
- Produces: [u’*/*’]
- 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
DELETE /group/peer/{peerGroupId}/solution/{solutionGroupId}
Removes access for the specified peer group to the specified solution group.
- Produces: [u’*/*’]
- 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
GET /group/peer/{peerId}/access
Gets peers accessible to the specified peer.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /group/peer
Creates a new peer group.
- Produces: [u’*/*’]
- 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/peer
Gets a page of peer groups, optionally sorted.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
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’*/*’]
- 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’*/*’]
- 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
POST /group/solution
Creates a new solution group.
- Produces: [u’*/*’]
- 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’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
artifact-controller¶
GET /artifact/like
Searches for artifacts with names or descriptions that contain the search term
- 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
PUT /artifact/{artifactId}
Updates an artifact.
- 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
DELETE /artifact/{artifactId}
Deletes the artifact with the specified ID.
- 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
GET /artifact/{artifactId}
Gets the artifact for the specified 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
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
POST /artifact
Creates a new artifact.
- 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
GET /artifact
Gets a page of artifacts, optionally sorted on fields.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /artifact/search
Searches for artifacts using the field name - field value pairs specified as query parameters. Defaults to and (conjunction); send junction query parameter = o for or (disjunction).
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
thread-controller¶
POST /thread
Creates a thread.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| thread | body | thread |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread
Gets a page of threads, optionally sorted.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/count
Gets the count of threads.
- Produces: [u’*/*’]
- 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’*/*’]
- 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 comment.
- Produces: [u’*/*’]
- 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
GET /thread/{threadId}/comment
Gets a page of comments in the thread.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| threadId | path | threadId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /thread/{threadId}
Updates a thread.
- Produces: [u’*/*’]
- 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
DELETE /thread/{threadId}
Deletes a thread.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| threadId | path | threadId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /thread/{threadId}
Gets the thread for the specified ID.
- Produces: [u’*/*’]
- 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}
Gets a page of threads for the solution and revision IDs, optionally sorted.
- Produces: [u’*/*’]
- 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
GET /thread/{threadId}/comment/count
Gets the number of comments in the thread.
- Produces: [u’*/*’]
- 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’*/*’]
- 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
PUT /thread/{threadId}/comment/{commentId}
Updates a comment.
- Produces: [u’*/*’]
- 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
DELETE /thread/{threadId}/comment/{commentId}
Deletes a comment.
- Produces: [u’*/*’]
- 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
GET /thread/{threadId}/comment/{commentId}
Gets the comment for the specified ID.
- Produces: [u’*/*’]
- 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
site-config-controller¶
POST /config
Creates a new site configuration.
- 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
PUT /config/{configKey}
Updates a site configuration.
- 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
DELETE /config/{configKey}
Deletes a site configuration.
- 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
GET /config/{configKey}
Gets the site configuration 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
role-controller¶
POST /role/{roleId}/function
Creates a new role function.
- Produces: [u’*/*’]
- 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
GET /role/{roleId}/function
Gets the functions for the specified role.
- Produces: [u’*/*’]
- 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 role function.
- Produces: [u’*/*’]
- 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
DELETE /role/{roleId}/function/{functionId}
Deletes a role function.
- Produces: [u’*/*’]
- 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
GET /role/{roleId}/function/{functionId}
Gets the role function for the specified role and function IDs.
- Produces: [u’*/*’]
- 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
GET /role/search
Searches for roles using the field name - field value pairs specified as query parameters. Defaults to and (conjunction); send junction query parameter = o for or (disjunction).
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /role/count
Gets the count of roles.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /role/{roleId}
Updates a role.
- Produces: [u’*/*’]
- 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
DELETE /role/{roleId}
Deletes a role.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| roleId | path | roleId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /role/{roleId}
Gets the role for the specified ID.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| roleId | path | roleId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /role
Creates a new role.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| role | body | role |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /role
Gets a page of roles, optionally sorted on fields.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
tag-controller¶
DELETE /tag/{tag}
Deletes a tag.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| tag | path | tag | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
POST /tag
Creates a new tag.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| tag | body | tag |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /tag
Gets a page of tags, optionally sorted.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
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’*/*’]
- 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’*/*’]
- 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’*/*’]
- 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.
- Produces: [u’*/*’]
- 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
POST /user/notifpref
Creates a new user notification preference
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| usrNotifPref | body | usrNotifPref |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /user/{userId}/role/{roleId}
Adds a role to the user.
- Produces: [u’*/*’]
- 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
DELETE /user/{userId}/role/{roleId}
Drops a role from the user.
- Produces: [u’*/*’]
- 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
GET /user/count
Gets the count of users.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /user/login
Checks the specified credentials. Searches both login name and email fields for the specified name. Returns the user object if an active user exists with the specified credentials; answers bad request if no match is found.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| login | body | login |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /user
Creates a new user.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| user | body | user |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user
Gets a page of users, optionally sorted on fields.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user/like
Searches for users with names that contain the search term.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| term | query | term | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}
Updates a user.
- Produces: [u’*/*’]
- 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
DELETE /user/{userId}
Deletes a user.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /user/{userId}
Gets the user for the specified ID.
- Produces: [u’*/*’]
- 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/role/{roleId}/count
Gets the count of users in a role.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| roleId | path | roleId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user/{userId}/favorite/solution
Gets a page of solutions which are favorites for the specified user ID.
- Produces: [u’*/*’]
- 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}/logprov/{providerCode}/login/{providerUserId}
Updates the specified user login provider entry.
- Produces: [u’*/*’]
- 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
POST /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Creates a user login provider entry.
- Produces: [u’*/*’]
- 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
DELETE /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Deletes the specified user login provider entry.
- Produces: [u’*/*’]
- 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
GET /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Gets the login provider for the specified user, provider code and provider login.
- Produces: [u’*/*’]
- 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
PUT /user/{userId}/chgpw
Sets the user’s password to the new value if the user exists, is active, and the old password matches.
- Produces: [u’*/*’]
- 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
PUT /user/notifpref/{userNotifPrefId}
Updates a user notification preference.
- Produces: [u’*/*’]
- 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
DELETE /user/notifpref/{userNotifPrefId}
Deletes the user notification preference with the specified ID.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| userNotifPrefId | path | userNotifPrefId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /user/notifpref/{userNotifPrefId}
Gets the user notification preference for the specified ID.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| userNotifPrefId | path | userNotifPrefId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user/{userId}/logprov
Gets all login providers for the specified user.
- Produces: [u’*/*’]
- 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.
- Produces: [u’*/*’]
- 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
GET /user/{userId}/role
Gets roles for the specified user ID.
- Produces: [u’*/*’]
- 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/{userId}/notif
Gets active notifications for the specified user ID.
- Produces: [u’*/*’]
- 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 using the field name - field value pairs specified as query parameters. Defaults to and (conjunction); send junction query parameter = o for or (disjunction).
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| queryParameters | query | queryParameters |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}/notif/{notificationId}
Updates the notification-user map; e.g., to record the date when the user viewed the notification.
- Produces: [u’*/*’]
- 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
POST /user/{userId}/notif/{notificationId}
Adds a user as a recipient of the notification.
- Produces: [u’*/*’]
- 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
DELETE /user/{userId}/notif/{notificationId}
Drops a user as a recipient of the notification.
- Produces: [u’*/*’]
- 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
GET /user/{userId}/deploy
Gets the deployments for the specified user ID.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /user/{userId}/favorite/solution/{solutionId}
Creates a new solution favorite record.
- Produces: [u’*/*’]
- 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
DELETE /user/{userId}/favorite/solution/{solutionId}
Deletes the specified solution favorite record.
- Produces: [u’*/*’]
- 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
GET /user/{userId}/notifpref
Gets notification preferences for the specified user ID.
- Produces: [u’*/*’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
