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 APIs in Clio Release¶
This section lists the methods in version 3.0.1, which is the last version in the Clio release.
code-table-controller¶
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
name | path | name | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /code/pair
Gets the list of value set names that can be used to fetch code-name pairs.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
catalog-controller¶
GET /catalog/solution/{solutionId}
Gets the catalogs where the specified solution is published; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /catalog/{catalogId}
Updates an existing catalog with the supplied data. Returns bad request on bad URI, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalog | body | catalog | |
catalogId | path | catalogId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /catalog/{catalogId}
Deletes the catalog with the specified ID. Cascades delete to related tables. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /catalog/{catalogId}
Gets the catalog for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /catalog/{catalogId}/solution/{solutionId}
Publishes the specified solution to the specified catalog. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
map | body | map | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /catalog/{catalogId}/solution/{solutionId}
Removes the specified solution from the specified solution.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /catalog/{catalogId}/solution/count
Gets the count of solutions in the specified catalog.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /catalog/solution
Gets a page of solutions in the specified catalogs, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ctlg | query | Catalog IDs | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /catalog/user/{userId}/favorite
Gets the list of catalog IDs that are favorites of the specified user; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /catalog
Creates a new catalog and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalog | body | catalog |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /catalog
Gets a page of catalogs, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /catalog/pubs
Gets the set of distinct catalog publishers. Answers empty if none are found.
- Produces: [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 /catalog/{catalogId}/user/{userId}/favorite
Marks the specified catalog as a favorite of the specified user. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /catalog/{catalogId}/user/{userId}/favorite
Removes the specified catalog as a favorite of the specified user.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /catalog/search
Searches for catalogs 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
accessTypeCode | query | accessTypeCode | string |
description | query | description | string |
name | query | name | string |
offset | query | integer | |
origin | query | origin | string |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
publisher | query | publisher | string |
selfPublish | query | selfPublish | boolean |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
url | query | url | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
access-controller¶
POST /access/solution/{solutionId}/user/{userId}
Grants write permission for the specified user to 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 /access/solution/{solutionId}/user/{userId}
Removes write permission for the specified user from the specified solution. Returns bad request if an ID is not found
- Produces: [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 /access/peer/{peerId}/solution/{solutionId}
Checks if the specified peer can read the specified solution. Returns non-zero if yes, zero if no.
- Produces: [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 /access/peer/{peerId}/catalog/{catalogId}
Add read access to the specified restricted catalog for the specified peer. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
peerId | path | peerId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /access/peer/{peerId}/catalog/{catalogId}
Removes read access to the specified restricted catalog for the specified peer.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
peerId | path | peerId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /access/peer/{peerId}/catalog/{catalogId}
Checks if the specified peer can read the specified catalog. Returns non-zero if yes, zero if no.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /access/user/{userId}/solution
Gets a page of solutions for which the user has write permission but is not the owner, optionally sorted on fields. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /access/peer/{peerId}/catalog
Gets the list of catalog IDs accessible to the specified peer; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /access/user/{userId}/solution/{solutionId}
Checks if the specified user can read the specified solution. Returns non-zero if yes, zero if no.
- Produces: [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
GET /access/solution/{solutionId}/user
Gets the list of users who were granted write access to the specified solution.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /access/catalog/{catalogId}/peer
Gets the list of peers with access to the specified restricted catalog; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
revision-controller¶
GET /revision/{revisionId}/artifact
Gets the artifacts for the specified solution revision. Answers empty if none are found.
- Produces: [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}/catalog/{catalogId}/descr
Updates an existing description with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
description | body | description | |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /revision/{revisionId}/catalog/{catalogId}/descr
Creates a new description for the specified revision and catalog. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
description | body | description | |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /revision/{revisionId}/catalog/{catalogId}/descr
Deletes the description with the specified IDs. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /revision/{revisionId}/catalog/{catalogId}/descr
Gets the description for the specified revision and catalog. Returns null if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /revision/{revisionId}/catalog/{catalogId}/document/{documentId}
Adds a user document to the specified revision and catalog.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
documentId | path | documentId | string |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /revision/{revisionId}/catalog/{catalogId}/document/{documentId}
Removes a document from the specified revision and catalog.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
documentId | path | documentId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /revision/{revisionId}/catalog/{catalogId}/document
Gets the documents for the specified revision and catalog.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /revision/{revisionId}/artifact/{artifactId}
Adds the specified artifact to the specified solution revision. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /revision/{revisionId}/artifact/{artifactId}
Removes the specified artifact from the specified solution revision.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
workbench-controller¶
GET /wkbn/proj/{projectId}/ppl
Gets the workbench pipelines mapped to the specified project ID. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/ntbk
Creates a new notebook and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebook | body | notebook |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/ntbk
Gets a page of notebooks, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/proj/{projectId}/ppl/{pipelineId}
Maps the specified pipeline to the specified project.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
projectId | path | projectId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /wkbn/proj/{projectId}/ppl/{pipelineId}
Umaps the specified pipeline from the specified project.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
projectId | path | projectId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/ppl/{pipelineId}/proj
Gets the workbench projects to which the specified pipeline is mapped. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/ntbk/{notebookId}/proj
Gets the workbench projects to which the specified notebook is mapped. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/proj/{projectId}/ntbk
Gets the workbench notebooks mapped to the specified project ID. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/ppl/search
Searches for pipelines 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
repositoryUrl | query | repositoryUrl | string |
serviceStatusCode | query | serviceStatusCode | string |
serviceUrl | query | serviceUrl | string |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/ntbk/search
Searches for notebooks 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
repositoryUrl | query | repositoryUrl | string |
serviceStatusCode | query | serviceStatusCode | string |
serviceUrl | query | serviceUrl | string |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /wkbn/proj
Creates a new project and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
project | body | project |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/proj
Gets a page of projects, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/proj/{projectId}/ntbk/{notebookId}
Maps the specified notebook to the specified project.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
projectId | path | projectId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /wkbn/proj/{projectId}/ntbk/{notebookId}
Unmaps the specified notebook from the specified project.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
projectId | path | projectId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
PUT /wkbn/proj/{projectId}
Updates an existing project with the supplied data. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
project | body | project | |
projectId | path | projectId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /wkbn/proj/{projectId}
Deletes the project with the specified ID. Cascades delete to related mapping records.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/proj/{projectId}
Gets the project for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/ppl
Creates a new pipeline and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipeline | body | pipeline |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/ppl
Gets a page of pipelines, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /wkbn/ntbk/{notebookId}
Updates an existing notebook with the supplied data. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebook | body | notebook | |
notebookId | path | notebookId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /wkbn/ntbk/{notebookId}
Deletes the notebook with the specified ID. Cascades delete to related mapping records.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/ntbk/{notebookId}
Gets the notebook for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/proj/search
Searches for projects 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
repositoryUrl | query | repositoryUrl | string |
serviceStatusCode | query | serviceStatusCode | string |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /wkbn/ppl/{pipelineId}
Updates an existing pipeline with the supplied data. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipeline | body | pipeline | |
pipelineId | path | pipelineId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /wkbn/ppl/{pipelineId}
Deletes the pipeline with the specified ID. Cascades delete to related mapping records.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/ppl/{pipelineId}
Gets the pipeline for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
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. Returns empty if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif/count
Gets the count of notifications.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif/user/{userId}
Gets a page of active notifications for the specified user; returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
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; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
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
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 |
---|---|---|---|
notif | body | notif | |
notificationId | path | notificationId | string |
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notificationId | path | notificationId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /notif/user/{userId}/unread/count
Gets the count of unread active notifications for the specified user.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /notif/notifpref/{userNotifPrefId}
Updates an existing user notification preference 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 user notification preference with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userNotifPrefId | path | userNotifPrefId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /notif/{notificationId}/user/{userId}
Records that the user viewed the notification by storing the current date and time. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notifUserMap | body | notifUserMap | |
notificationId | path | notificationId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /notif/{notificationId}/user/{userId}
Adds the specified 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 |
---|---|---|---|
notifUserMap | body | notifUserMap | |
notificationId | path | notificationId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /notif/{notificationId}/user/{userId}
Drops the specified user as a recipient of the notification.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notificationId | path | notificationId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
healthcheck-controller¶
GET /healthcheck
Checks the health of the application by querying the database.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /version
Gets the server version, which is the value of the MANIFEST.MF property Implementation-Version as written by maven.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
publish-request-controller¶
POST /pubreq
Creates a new publish 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 |
---|---|---|---|
pubReq | body | pubReq |
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. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /pubreq/{requestId}
Updates an existing publish 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 |
---|---|---|---|
pubReq | body | pubReq | |
requestId | path | requestId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /pubreq/{requestId}
Deletes the publish request with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 publish request for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
requestId | path | requestId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /pubreq/search
Searches for publish 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
requestUserId | query | requestUserId | string |
reviewUserId | query | reviewUserId | string |
revisionId | query | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | query | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
tag-controller¶
DELETE /tag/{tag}
Deletes the specified solution tag. Returns bad request if not found.
- Produces: [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 solution 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 solution tags, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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
GET /peer/{peerId}/sub/count
Gets count of subscriptions for the specified peer.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /peer/{peerId}
Updates an existing peer with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peer | body | peer | |
peerId | path | peerId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /peer/{peerId}
Deletes the peer with the specified ID. Cascades delete to peer subscriptions. Returns bad request if the ID is not found.
- Produces: [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 peer with the specified ID. Returns null if the ID is not found.
- Produces: [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. Returns empty if none are found
- Produces: [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 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; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /peer/sub/{subId}
Updates an existing peer subscription with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerSub | body | peerSub | |
subId | path | subId | integer |
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’]
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. Returns null if not found.
- Produces: [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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
apiUrl | query | apiUrl | string |
contact1 | query | contact1 | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
self | query | self | boolean |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
subjectName | query | subjectName | string |
unpaged | query | boolean | |
webUrl | query | webUrl | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
task-controller¶
GET /task/stepresult/search
Searches for step results 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
taskId | query | taskId | integer |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /task
Creates a new task with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
task | body | task |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /task
Gets a page of tasks, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /task/{taskId}
Updates an existing task with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
task | body | task | |
taskId | path | taskId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /task/{taskId}
Deletes the task with the specified ID. Cascades the delete to associated step results. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
taskId | path | taskId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /task/{taskId}
Gets the task for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
taskId | path | taskId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /task/stepresult/{stepResultId}
Updates an existing task step result with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResult | body | stepResult | |
stepResultId | path | stepResultId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /task/stepresult/{stepResultId}
Deletes the task step result with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 /task/stepresult/{stepResultId}
Gets the task step result with the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResultId | path | stepResultId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /task/{taskId}/stepresult
Gets all step results associated with the specified task ID. Answers empty if none are found.
- Produces: [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 |
taskId | path | taskId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /task/stepresult
Creates a new task step result 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 /task/search
Searches for tasks 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | query | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | query | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
taskCode | query | taskCode | string |
taskId | query | taskId | integer |
trackingId | query | trackingId | string |
unpaged | query | boolean | |
userId | query | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
artifact-controller¶
GET /artifact/like
Searches for artifacts with names or descriptions that contain the search term using the like operator; empty if no matches are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
term | query | term | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /artifact/{artifactId}
Updates an existing artifact with the supplied data. Returns bad request on bad URI, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifact | body | artifact | |
artifactId | path | artifactId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /artifact/{artifactId}
Deletes the artifact with the specified ID. Cascades delete to related records.
- Produces: [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 artifact with the specified ID. Returns null if the ID is not found.
- Produces: [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’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /artifact/{artifactId}/revision
Gets the solution revisions that use the specified artifact.
- Produces: [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 and generates an ID if needed. Returns bad request on bad URI, 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; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
artifactTypeCode | query | artifactTypeCode | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
uri | query | uri | string |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
site-controller¶
POST /site/config
Creates a new site configuration object. 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
GET /site/config
Gets a page of site configurations, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /site/content
Creates a new site content object. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
siteContent | body | siteContent |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /site/content
Gets a page of site content objects, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /site/content/{contentKey}
Updates an existing site content object with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
contentKey | path | contentKey | string |
siteContent | body | siteContent |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /site/content/{contentKey}
Deletes the site content object with the specified key. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
contentKey | path | contentKey | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /site/content/{contentKey}
Gets the site content object for the specified key. Answers null if the key is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
contentKey | path | contentKey | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /site/config/{configKey}
Updates an existing site configuration 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 /site/config/{configKey}
Deletes the site configuration with the specified key. Returns bad request if the ID is not found.
- Produces: [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 /site/config/{configKey}
Gets the site configuration for the specified key. Returns null if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
configKey | path | configKey | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
license-controller¶
POST /lic/templ
Creates a new license profile template. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
template | body | template |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /lic/templ
Gets a page of license profile templates, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /lic/templ/{licenseId}
Updates an existing license profile template with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
licenseId | path | licenseId | integer |
licenseTemplate | body | licenseTemplate |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /lic/templ/{licenseId}
Deletes the license profile template with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
licenseId | path | licenseId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /lic/templ/{licenseId}
Gets the license profile template for the specified ID. Returns null if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
licenseId | path | licenseId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
role-controller¶
POST /role/{roleId}/function
Creates a new role function and generates an ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleFunction | body | roleFunction | |
roleId | path | roleId | string |
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 empty if none are found.
- Produces: [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 with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
functionId | path | functionId | string |
roleFunction | body | roleFunction | |
roleId | path | roleId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /role/{roleId}/function/{functionId}
Deletes the role function with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
functionId | path | functionId | string |
roleId | path | roleId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /role/{roleId}/function/{functionId}
Gets the role function with the specified ID. Returns null if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
functionId | path | functionId | string |
roleId | path | roleId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /role/{roleId}
Updates an existing role with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
role | body | role | |
roleId | path | roleId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /role/{roleId}
Deletes the role with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 role for the specified ID. Returns null if the ID is not found.
- Produces: [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 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. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
document-controller¶
POST /document
Creates a new document object and generates an ID if needed. Returns bad request on bad URI, 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
PUT /document/{documentId}
Updates an existing document with the supplied data. Returns bad request on bad URI, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
document | body | document | |
documentId | path | documentId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /document/{documentId}
Deletes the document with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 document object for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
documentId | path | documentId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
thread-controller¶
GET /thread/solution/{solutionId}/revision/{revisionId}/count
Gets the count of threads for the solution and revision IDs.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /thread
Creates a new thread 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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/count
Gets the count of threads.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/solution/{solutionId}/revision/{revisionId}/comment/count
Gets the count of comments in all threads for the specified solution and revision IDs.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /thread/{threadId}/comment
Creates a new comment 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 |
---|---|---|---|
comment | body | comment | |
threadId | path | threadId | string |
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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
threadId | path | threadId | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /thread/{threadId}
Updates an existing thread with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
thread | body | thread | |
threadId | path | threadId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /thread/{threadId}
Deletes the thread with the specified ID. Cascades to comments in the thread. Returns bad request if the ID is not found.
- Produces: [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 null if an ID is not found.
- Produces: [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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/{threadId}/comment/count
Gets the count of comments in the specified thread.
- Produces: [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 specified solution and revision IDs, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /thread/{threadId}/comment/{commentId}
Updates an existing comment with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
comment | body | comment | |
commentId | path | commentId | string |
threadId | path | threadId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /thread/{threadId}/comment/{commentId}
Deletes the comment with the specified ID. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
commentId | path | commentId | string |
threadId | path | threadId | 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 null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
commentId | path | commentId | string |
threadId | path | threadId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
right-to-use-controller¶
PUT /rtu/{rtuId}
Updates an existing RTU object with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtu | body | rtu | |
rtuId | path | rtuId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /rtu/{rtuId}
Deletes the RTU object with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtuId | path | rtuId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /rtu/{rtuId}
Gets the right-to-use object for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtuId | path | rtuId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /rtu/{rtuId}/user
Gets all users mapped to the specified RTU. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
rtuId | path | rtuId | 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 /rtu/ref
Creates a new RTU reference. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ref | body | ref |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /rtu/ref
Gets a page of RTU references, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /rtu/{rtuId}/ref/{refId}
Adds the specified reference to the specified RTU. Answers bad request if the RTU ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
map | body | map | |
refId | path | refId | string |
rtuId | path | rtuId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /rtu/{rtuId}/ref/{refId}
Removes the specified reference from the specified RTU.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
refId | path | refId | string |
rtuId | path | rtuId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /rtu/solution/{solutionId}/user/{userId}
Gets a list of right-to-use objects for the specified solution and user. Returns empty if none are found.
- Produces: [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
POST /rtu/{rtuId}/user/{userId}
Adds the specified user to the specified RTU. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
map | body | map | |
rtuId | path | rtuId | integer |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /rtu/{rtuId}/user/{userId}
Removes the specified user from the specified RTU.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtuId | path | rtuId | integer |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /rtu/ref/{referenceId}
Gets the right-to-use objects to which the specified reference is mapped. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
referenceId | path | referenceId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /rtu/search
Searches for right-to-use objects 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
site | query | site | boolean |
size | query | Number of records per page. | integer |
solutionId | query | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /rtu
Creates a new RTU object and generates an ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtu | body | rtu |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /rtu
Gets a page of right-to-use objects, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /rtu/ref/{ref}
Deletes the specified RTU reference. Returns bad request if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ref | path | ref | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
user-controller¶
PUT /user/role/{roleId}
Adds or removes the specified role for every specified user. 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
POST /user/{userId}/role/{roleId}
Adds the specified role to the specified user’s roles. 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 |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/role/{roleId}
Removes the specified role from the specified user’s roles.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/count
Gets the count of users.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user/like
Returns a page of users with names that contain the search term matched using a like operator on the first, middle, last and login-name fields. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
term | query | term | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}
Updates an existing user with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
user | body | user | |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}
Deletes the user with the specified ID. Cascades to related entities: roles, logins, notifications. Returns bad request if the ID is not found.
- Produces: [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 null if the ID is not found.
- Produces: [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 with the specified role.
- Produces: [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 that the specified user has marked as favorite. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Updates an existing user login provider with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
ulp | body | ulp | |
userId | path | userId | string |
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 user login provider. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
ulp | body | ulp | |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Deletes the specified user login provider. Returns bad request if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
userId | path | userId | 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 null if an ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
userId | path | userId | string |
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/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
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 |
---|---|---|---|
changeRequest | body | changeRequest | |
userId | path | userId | string |
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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /user
Creates a new user 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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}/role
Assigns the specified roles to the specified 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 |
---|---|---|---|
roleIds | body | roleIds | |
userId | path | userId | string |
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. Answers empty if noe are found.
- Produces: [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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
query | string | ||
firstName | query | firstName | string |
lastName | query | lastName | string |
loginName | query | loginName | string |
middleName | query | middleName | string |
offset | query | integer | |
orgName | query | orgName | string |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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 |
---|---|---|---|
tag | path | tag | string |
userId | path | userId | 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
tag | path | tag | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/{userId}/deploy
Gets a page of solution deployments for the specified user ID. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
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. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
sfv | body | sfv | |
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/favorite/solution/{solutionId}
Deletes the solution favorite with the specified IDs. Returns bad request if the entity is not found.
- Produces: [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
solution-controller¶
DELETE /solution/{solutionId}/dnld/{downloadId}
Deletes the solution download object with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
downloadId | path | downloadId | integer |
solutionId | path | solutionId | string |
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’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{parentId}/comp
Gets the member solution IDs in the specified composite solution. Answers empty if none are found.
- Produces: [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 |
---|---|---|---|
revisionId | path | revisionId | string |
sd | body | sd | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision/{revisionId}/deploy
Gets a page of deployments for the specified solution and revision IDs. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/user
Gets a page of solutions editable by the specified user and matching all query parameters. Keywords are processed using LIKE-operator search. Does not search any child entities.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
desc | query | Description key words | array |
mtc | query | Model type codes | array |
name | query | Name key words | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
publ | query | Published Y/N | boolean |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
tag | query | Tags | array |
unpaged | query | boolean | |
user | query | User ID | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{solutionId}/revision/{revisionId}/user/{userId}/deploy
Gets a page of deployments for the specified solution, revision and user IDs. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Updates an existing deployment record with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
deploymentId | path | deploymentId | string |
revisionId | path | revisionId | string |
sd | body | sd | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Deletes the deployment record with the specified IDs. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
deploymentId | path | deploymentId | string |
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
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
GET /solution/{solutionId}/rating
Gets a page of user ratings for the specified solution. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
solutionId | path | solutionId | string |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution
Creates a new solution 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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/date
Finds published solutions based on specified catalog and date query parameters. Limits result to solutions, revisions, artifacts etc. modified after the specified time, expressed in milliseconds since the Epoch.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ctlg | query | Catalog IDs | array |
inst | query | Milliseconds since the Epoch | integer |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{parentId}/comp/{childId}
Adds the specified member (child) to the specified composite solution (parent). Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
childId | path | childId | string |
parentId | path | parentId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{parentId}/comp/{childId}
Removes the specified member (child) from the specified composite solution (parent).
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
childId | path | childId | string |
parentId | path | parentId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/tag
Gets all tags assigned to the specified solution ID. Answers empty if none are found.
- Produces: [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/like
Searches for solutions with names or descriptions that contain the search term using the like operator. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
term | query | term | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/revision
Creates a new 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 |
---|---|---|---|
revision | body | revision | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision
Gets all revisions for the specified solution IDs. Answers empty if none are found.
- Produces: [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
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
auth | query | Author key words | array |
desc | query | Description key words | array |
mtc | query | Model type codes | array |
name | query | Name key words | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
pub | query | Publisher key words | array |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
tag | query | Tags | array |
unpaged | query | boolean | |
user | query | User IDs | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/portal/kwtag
Finds published 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
alltag | query | All tags, solution must have every one | array |
anytag | query | Any tags, solution must have at least one | array |
ctlg | query | Catalog IDs | array |
kw | query | Key words | array |
mtc | query | Model type codes | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
user | query | User IDs | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}
Updates an existing solution with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solution | body | solution | |
solutionId | path | solutionId | string |
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’]
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 null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}/rating/user/{userId}
Updates an existing solution rating 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 |
sr | body | sr | |
userId | path | userId | string |
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 |
sr | body | sr | |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /solution/{solutionId}/rating/user/{userId}
Deletes the solution rating for the specified IDs. Returns bad request if not found.
- Produces: [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 the rating for the specified solution and user. Returns null if not found
- Produces: [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
PUT /solution/{solutionId}/pic
Saves or updates a solution image. Returns bad request if the ID is not found or the image is too large.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
picture | body | picture | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/pic
Gets the image for the specified solution ID. Returns null if the ID is not found.
- Produces: [u’application/octet-stream’]
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}/dnld
Gets a page of download details for the specified solution’s artifacts. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/tag/{tag}
Adds the specified tag to the specified solution. Creates the tag if necessary. Returns bad request if the solution 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}
Removes the specified tag from the specified solution. Returns bad request if either is not found.
- Produces: [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
POST /solution/{solutionId}/dnld/artifact/{artifactId}/user/{userId}
Creates a new solution download object with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
sd | body | sd | |
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/search/tag
Gets a page of solutions tagged with the specified tag. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
tag | query | tag | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}/revision/{revisionId}
Updates an existing revision with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revision | body | revision | |
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/revision/{revisionId}
Deletes the revision with the specified ID. Cascades delete to related records. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision/{revisionId}
Gets the solution revision for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search
Searches for solutions 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
modelTypeCode | query | modelTypeCode | string |
name | query | name | string |
offset | query | integer | |
origin | query | origin | string |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
sourceId | query | sourceId | string |
toolkitTypeCode | query | toolkitTypeCode | string |
unpaged | query | boolean | |
userId | query | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
CDS APIs in Boreas Release¶
This section lists the methods in version 2.2.2, which is the last version in the Boreas release.
code-table-controller¶
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
name | path | name | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /code/pair
Gets the list of value set names that can be used to fetch code-name pairs.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
catalog-controller¶
GET /catalog/solution/{solutionId}
Gets the catalogs where the specified solution is published; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /catalog/{catalogId}
Updates an existing catalog with the supplied data. Returns bad request on bad URI, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalog | body | catalog | |
catalogId | path | catalogId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /catalog/{catalogId}
Deletes the catalog with the specified ID. Cascades delete to related tables. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /catalog/{catalogId}
Gets the catalog for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /catalog/{catalogId}/solution/{solutionId}
Publishes the specified solution to the specified catalog. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
map | body | map | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /catalog/{catalogId}/solution/{solutionId}
Removes the specified solution from the specified solution.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /catalog/{catalogId}/solution/count
Gets the count of solutions in the specified catalog.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /catalog/solution
Gets a page of solutions in the specified catalogs, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ctlg | query | Catalog IDs | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /catalog/user/{userId}/favorite
Gets the list of catalog IDs that are favorites of the specified user; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /catalog
Creates a new catalog and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalog | body | catalog |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /catalog
Gets a page of catalogs, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /catalog/pubs
Gets the set of distinct catalog publishers. Answers empty if none are found.
- Produces: [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 /catalog/{catalogId}/user/{userId}/favorite
Marks the specified catalog as a favorite of the specified user. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /catalog/{catalogId}/user/{userId}/favorite
Removes the specified catalog as a favorite of the specified user.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /catalog/search
Searches for catalogs 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
accessTypeCode | query | accessTypeCode | string |
description | query | description | string |
name | query | name | string |
offset | query | integer | |
origin | query | origin | string |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
publisher | query | publisher | string |
selfPublish | query | selfPublish | boolean |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
url | query | url | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
access-controller¶
POST /access/solution/{solutionId}/user/{userId}
Grants write permission for the specified user to 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 /access/solution/{solutionId}/user/{userId}
Removes write permission for the specified user from the specified solution. Returns bad request if an ID is not found
- Produces: [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 /access/peer/{peerId}/solution/{solutionId}
Checks if the specified peer can read the specified solution. Returns non-zero if yes, zero if no.
- Produces: [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 /access/peer/{peerId}/catalog/{catalogId}
Add read access to the specified restricted catalog for the specified peer. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
peerId | path | peerId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /access/peer/{peerId}/catalog/{catalogId}
Removes read access to the specified restricted catalog for the specified peer.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
peerId | path | peerId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /access/peer/{peerId}/catalog/{catalogId}
Checks if the specified peer can read the specified catalog. Returns non-zero if yes, zero if no.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /access/user/{userId}/solution
Gets a page of solutions for which the user has write permission but is not the owner, optionally sorted on fields. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /access/peer/{peerId}/catalog
Gets the list of catalog IDs accessible to the specified peer; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /access/user/{userId}/solution/{solutionId}
Checks if the specified user can read the specified solution. Returns non-zero if yes, zero if no.
- Produces: [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
GET /access/solution/{solutionId}/user
Gets the list of users who were granted write access to the specified solution.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
revision-controller¶
GET /revision/{revisionId}/artifact
Gets the artifacts for the specified solution revision. Answers empty if none are found.
- Produces: [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}/catalog/{catalogId}/descr
Updates an existing description with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
description | body | description | |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /revision/{revisionId}/catalog/{catalogId}/descr
Creates a new description for the specified revision and catalog. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
description | body | description | |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /revision/{revisionId}/catalog/{catalogId}/descr
Deletes the description with the specified IDs. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /revision/{revisionId}/catalog/{catalogId}/descr
Gets the description for the specified revision and catalog. Returns null if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /revision/{revisionId}/catalog/{catalogId}/document/{documentId}
Adds a user document to the specified revision and catalog.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
documentId | path | documentId | string |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /revision/{revisionId}/catalog/{catalogId}/document/{documentId}
Removes a document from the specified revision and catalog.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
documentId | path | documentId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
GET /revision/{revisionId}/catalog/{catalogId}/document
Gets the documents for the specified revision and catalog.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
catalogId | path | catalogId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /revision/{revisionId}/artifact/{artifactId}
Adds the specified artifact to the specified solution revision. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
revisionId | path | revisionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /revision/{revisionId}/artifact/{artifactId}
Removes the specified artifact from the specified solution revision.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
revisionId | path | revisionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
workbench-controller¶
GET /wkbn/proj/{projectId}/ppl
Gets the workbench pipelines mapped to the specified project ID. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/ntbk
Creates a new notebook and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebook | body | notebook |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/ntbk
Gets a page of notebooks, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/proj/{projectId}/ppl/{pipelineId}
Maps the specified pipeline to the specified project.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
projectId | path | projectId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /wkbn/proj/{projectId}/ppl/{pipelineId}
Umaps the specified pipeline from the specified project.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
projectId | path | projectId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/ppl/{pipelineId}/proj
Gets the workbench projects to which the specified pipeline is mapped. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/ntbk/{notebookId}/proj
Gets the workbench projects to which the specified notebook is mapped. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/proj/{projectId}/ntbk
Gets the workbench notebooks mapped to the specified project ID. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/ppl/search
Searches for pipelines 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
repositoryUrl | query | repositoryUrl | string |
serviceStatusCode | query | serviceStatusCode | string |
serviceUrl | query | serviceUrl | string |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/ntbk/search
Searches for notebooks 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
repositoryUrl | query | repositoryUrl | string |
serviceStatusCode | query | serviceStatusCode | string |
serviceUrl | query | serviceUrl | string |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /wkbn/proj
Creates a new project and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
project | body | project |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/proj
Gets a page of projects, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/proj/{projectId}/ntbk/{notebookId}
Maps the specified notebook to the specified project.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
projectId | path | projectId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /wkbn/proj/{projectId}/ntbk/{notebookId}
Unmaps the specified notebook from the specified project.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
projectId | path | projectId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
PUT /wkbn/proj/{projectId}
Updates an existing project with the supplied data. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
project | body | project | |
projectId | path | projectId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /wkbn/proj/{projectId}
Deletes the project with the specified ID. Cascades delete to related mapping records.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/proj/{projectId}
Gets the project for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
projectId | path | projectId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /wkbn/ppl
Creates a new pipeline and generates an ID if needed. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipeline | body | pipeline |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /wkbn/ppl
Gets a page of pipelines, optionally sorted; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /wkbn/ntbk/{notebookId}
Updates an existing notebook with the supplied data. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebook | body | notebook | |
notebookId | path | notebookId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /wkbn/ntbk/{notebookId}
Deletes the notebook with the specified ID. Cascades delete to related mapping records.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/ntbk/{notebookId}
Gets the notebook for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notebookId | path | notebookId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /wkbn/proj/search
Searches for projects 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
repositoryUrl | query | repositoryUrl | string |
serviceStatusCode | query | serviceStatusCode | string |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /wkbn/ppl/{pipelineId}
Updates an existing pipeline with the supplied data. Returns bad request on bad URL, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipeline | body | pipeline | |
pipelineId | path | pipelineId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /wkbn/ppl/{pipelineId}
Deletes the pipeline with the specified ID. Cascades delete to related mapping records.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /wkbn/ppl/{pipelineId}
Gets the pipeline for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
pipelineId | path | pipelineId | string |
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. Returns empty if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif/count
Gets the count of notifications.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /notif/user/{userId}
Gets a page of active notifications for the specified user; returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
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; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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 |
---|---|---|---|
notif | body | notif | |
notificationId | path | notificationId | string |
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notificationId | path | notificationId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
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
GET /notif/user/{userId}/unread/count
Gets the count of unread active notifications for the specified user.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /notif/notifpref/{userNotifPrefId}
Updates an existing user notification preference 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 user notification preference with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userNotifPrefId | path | userNotifPrefId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /notif/{notificationId}/user/{userId}
Records that the user viewed the notification by storing the current date and time. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notifUserMap | body | notifUserMap | |
notificationId | path | notificationId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /notif/{notificationId}/user/{userId}
Adds the specified 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 |
---|---|---|---|
notifUserMap | body | notifUserMap | |
notificationId | path | notificationId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /notif/{notificationId}/user/{userId}
Drops the specified user as a recipient of the notification.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
notificationId | path | notificationId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
healthcheck-controller¶
GET /healthcheck
Checks the health of the application by querying the database.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /version
Gets the server version, which is the value of the MANIFEST.MF property Implementation-Version as written by maven.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
publish-request-controller¶
POST /pubreq
Creates a new publish 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 |
---|---|---|---|
pubReq | body | pubReq |
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. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /pubreq/{requestId}
Updates an existing publish 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 |
---|---|---|---|
pubReq | body | pubReq | |
requestId | path | requestId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /pubreq/{requestId}
Deletes the publish request with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 publish request for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
requestId | path | requestId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /pubreq/search
Searches for publish 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
requestUserId | query | requestUserId | string |
reviewUserId | query | reviewUserId | string |
revisionId | query | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | query | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
tag-controller¶
DELETE /tag/{tag}
Deletes the specified solution tag. Returns bad request if not found.
- Produces: [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 solution 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 solution tags, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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
GET /peer/{peerId}/sub/count
Gets count of subscriptions for the specified peer.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerId | path | peerId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /peer/{peerId}
Updates an existing peer with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peer | body | peer | |
peerId | path | peerId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /peer/{peerId}
Deletes the peer with the specified ID. Cascades delete to peer subscriptions. Returns bad request if the ID is not found.
- Produces: [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 peer with the specified ID. Returns null if the ID is not found.
- Produces: [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. Returns empty if none are found
- Produces: [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 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; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /peer/sub/{subId}
Updates an existing peer subscription with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
peerSub | body | peerSub | |
subId | path | subId | integer |
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’]
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. Returns null if not found.
- Produces: [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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
apiUrl | query | apiUrl | string |
contact1 | query | contact1 | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
self | query | self | boolean |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
subjectName | query | subjectName | string |
unpaged | query | boolean | |
webUrl | query | webUrl | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
task-controller¶
GET /task/stepresult/search
Searches for step results 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
taskId | query | taskId | integer |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /task
Creates a new task with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
task | body | task |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /task
Gets a page of tasks, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /task/{taskId}
Updates an existing task with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
task | body | task | |
taskId | path | taskId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /task/{taskId}
Deletes the task with the specified ID. Cascades the delete to associated step results. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
taskId | path | taskId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /task/{taskId}
Gets the task for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
taskId | path | taskId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /task/stepresult/{stepResultId}
Updates an existing task step result with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResult | body | stepResult | |
stepResultId | path | stepResultId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /task/stepresult/{stepResultId}
Deletes the task step result with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 /task/stepresult/{stepResultId}
Gets the task step result with the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
stepResultId | path | stepResultId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /task/{taskId}/stepresult
Gets all step results associated with the specified task ID. Answers empty if none are found.
- Produces: [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 |
taskId | path | taskId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /task/stepresult
Creates a new task step result 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 /task/search
Searches for tasks 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | query | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | query | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
statusCode | query | statusCode | string |
taskCode | query | taskCode | string |
taskId | query | taskId | integer |
trackingId | query | trackingId | string |
unpaged | query | boolean | |
userId | query | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
artifact-controller¶
GET /artifact/like
Searches for artifacts with names or descriptions that contain the search term using the like operator; empty if no matches are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
term | query | term | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /artifact/{artifactId}
Updates an existing artifact with the supplied data. Returns bad request on bad URI, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifact | body | artifact | |
artifactId | path | artifactId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /artifact/{artifactId}
Deletes the artifact with the specified ID. Cascades delete to related records.
- Produces: [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 artifact with the specified ID. Returns null if the ID is not found.
- Produces: [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’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /artifact/{artifactId}/revision
Gets the solution revisions that use the specified artifact.
- Produces: [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 and generates an ID if needed. Returns bad request on bad URI, 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; empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
artifactTypeCode | query | artifactTypeCode | string |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
uri | query | uri | string |
userId | query | userId | string |
version | query | version | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
site-controller¶
POST /site/config
Creates a new site configuration object. 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
GET /site/config
Gets a page of site configurations, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /site/content
Creates a new site content object. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
siteContent | body | siteContent |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /site/content
Gets a page of site content objects, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /site/content/{contentKey}
Updates an existing site content object with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
contentKey | path | contentKey | string |
siteContent | body | siteContent |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /site/content/{contentKey}
Deletes the site content object with the specified key. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
contentKey | path | contentKey | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /site/content/{contentKey}
Gets the site content object for the specified key. Answers null if the key is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
contentKey | path | contentKey | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /site/config/{configKey}
Updates an existing site configuration 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 /site/config/{configKey}
Deletes the site configuration with the specified key. Returns bad request if the ID is not found.
- Produces: [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 /site/config/{configKey}
Gets the site configuration for the specified key. Returns null if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
configKey | path | configKey | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
right-to-use-controller¶
PUT /rtu/{rtuId}
Updates an existing RTU object with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtu | body | rtu | |
rtuId | path | rtuId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /rtu/{rtuId}
Deletes the RTU object with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtuId | path | rtuId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /rtu/{rtuId}
Gets the right-to-use object for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtuId | path | rtuId | integer |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /rtu/{rtuId}/user
Gets all users mapped to the specified RTU. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
page | query | Results page you want to retrieve (0..N) | integer |
rtuId | path | rtuId | 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 /rtu/ref
Creates a new RTU reference. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ref | body | ref |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /rtu/ref
Gets a page of RTU references, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /rtu/{rtuId}/ref/{refId}
Adds the specified reference to the specified RTU. Answers bad request if the RTU ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
map | body | map | |
refId | path | refId | string |
rtuId | path | rtuId | integer |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /rtu/{rtuId}/ref/{refId}
Removes the specified reference from the specified RTU.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
refId | path | refId | string |
rtuId | path | rtuId | integer |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /rtu/solution/{solutionId}/user/{userId}
Gets a list of right-to-use objects for the specified solution and user. Returns empty if none are found.
- Produces: [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
POST /rtu/{rtuId}/user/{userId}
Adds the specified user to the specified RTU. Answers bad request if an ID is invalid.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
map | body | map | |
rtuId | path | rtuId | integer |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /rtu/{rtuId}/user/{userId}
Removes the specified user from the specified RTU.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtuId | path | rtuId | integer |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /rtu/ref/{referenceId}
Gets the right-to-use objects to which the specified reference is mapped. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
referenceId | path | referenceId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /rtu/search
Searches for right-to-use objects 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
site | query | site | boolean |
size | query | Number of records per page. | integer |
solutionId | query | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
POST /rtu
Creates a new RTU object and generates an ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
rtu | body | rtu |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /rtu
Gets a page of right-to-use objects, optionally sorted on fields. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /rtu/ref/{ref}
Deletes the specified RTU reference. Returns bad request if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ref | path | ref | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
role-controller¶
POST /role/{roleId}/function
Creates a new role function and generates an ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleFunction | body | roleFunction | |
roleId | path | roleId | string |
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 empty if none are found.
- Produces: [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 with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
functionId | path | functionId | string |
roleFunction | body | roleFunction | |
roleId | path | roleId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /role/{roleId}/function/{functionId}
Deletes the role function with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
functionId | path | functionId | string |
roleId | path | roleId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /role/{roleId}/function/{functionId}
Gets the role function with the specified ID. Returns null if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
functionId | path | functionId | string |
roleId | path | roleId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
name | query | name | string |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /role/{roleId}
Updates an existing role with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
role | body | role | |
roleId | path | roleId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /role/{roleId}
Deletes the role with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 role for the specified ID. Returns null if the ID is not found.
- Produces: [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 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. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
document-controller¶
POST /document
Creates a new document object and generates an ID if needed. Returns bad request on bad URI, 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
PUT /document/{documentId}
Updates an existing document with the supplied data. Returns bad request on bad URI, constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
document | body | document | |
documentId | path | documentId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /document/{documentId}
Deletes the document with the specified ID. Returns bad request if the ID is not found.
- Produces: [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 document object for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
documentId | path | documentId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
thread-controller¶
GET /thread/solution/{solutionId}/revision/{revisionId}/count
Gets the count of threads for the solution and revision IDs.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /thread
Creates a new thread 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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/count
Gets the count of threads.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/solution/{solutionId}/revision/{revisionId}/comment/count
Gets the count of comments in all threads for the specified solution and revision IDs.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /thread/{threadId}/comment
Creates a new comment 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 |
---|---|---|---|
comment | body | comment | |
threadId | path | threadId | string |
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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
threadId | path | threadId | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /thread/{threadId}
Updates an existing thread with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
thread | body | thread | |
threadId | path | threadId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /thread/{threadId}
Deletes the thread with the specified ID. Cascades to comments in the thread. Returns bad request if the ID is not found.
- Produces: [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 null if an ID is not found.
- Produces: [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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /thread/{threadId}/comment/count
Gets the count of comments in the specified thread.
- Produces: [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 specified solution and revision IDs, optionally sorted. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /thread/{threadId}/comment/{commentId}
Updates an existing comment with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
comment | body | comment | |
commentId | path | commentId | string |
threadId | path | threadId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /thread/{threadId}/comment/{commentId}
Deletes the comment with the specified ID. Returns bad request if an ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
commentId | path | commentId | string |
threadId | path | threadId | 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 null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
commentId | path | commentId | string |
threadId | path | threadId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
user-controller¶
PUT /user/role/{roleId}
Adds or removes the specified role for every specified user. 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
POST /user/{userId}/role/{roleId}
Adds the specified role to the specified user’s roles. 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 |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/role/{roleId}
Removes the specified role from the specified user’s roles.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
roleId | path | roleId | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/count
Gets the count of users.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /user/like
Returns a page of users with names that contain the search term matched using a like operator on the first, middle, last and login-name fields. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
term | query | term | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}
Updates an existing user with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
user | body | user | |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}
Deletes the user with the specified ID. Cascades to related entities: roles, logins, notifications. Returns bad request if the ID is not found.
- Produces: [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 null if the ID is not found.
- Produces: [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 with the specified role.
- Produces: [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 that the specified user has marked as favorite. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Updates an existing user login provider with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
ulp | body | ulp | |
userId | path | userId | string |
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 user login provider. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
ulp | body | ulp | |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/logprov/{providerCode}/login/{providerUserId}
Deletes the specified user login provider. Returns bad request if not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
userId | path | userId | 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 null if an ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
providerCode | path | providerCode | string |
providerUserId | path | providerUserId | string |
userId | path | userId | string |
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/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
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 |
---|---|---|---|
changeRequest | body | changeRequest | |
userId | path | userId | string |
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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /user
Creates a new user 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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /user/{userId}/role
Assigns the specified roles to the specified 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 |
---|---|---|---|
roleIds | body | roleIds | |
userId | path | userId | string |
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. Answers empty if noe are found.
- Produces: [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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
query | string | ||
firstName | query | firstName | string |
lastName | query | lastName | string |
loginName | query | loginName | string |
middleName | query | middleName | string |
offset | query | integer | |
orgName | query | orgName | string |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
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 |
---|---|---|---|
tag | path | tag | string |
userId | path | userId | 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
tag | path | tag | string |
userId | path | userId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /user/{userId}/deploy
Gets a page of solution deployments for the specified user ID. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
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. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
sfv | body | sfv | |
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /user/{userId}/favorite/solution/{solutionId}
Deletes the solution favorite with the specified IDs. Returns bad request if the entity is not found.
- Produces: [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
solution-controller¶
DELETE /solution/{solutionId}/dnld/{downloadId}
Deletes the solution download object with the specified ID. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
downloadId | path | downloadId | integer |
solutionId | path | solutionId | string |
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’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{parentId}/comp
Gets the member solution IDs in the specified composite solution. Answers empty if none are found.
- Produces: [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 |
---|---|---|---|
revisionId | path | revisionId | string |
sd | body | sd | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision/{revisionId}/deploy
Gets a page of deployments for the specified solution and revision IDs. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/user
Gets a page of solutions editable by the specified user and matching all query parameters. Keywords are processed using LIKE-operator search. Does not search any child entities.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
desc | query | Description key words | array |
mtc | query | Model type codes | array |
name | query | Name key words | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
publ | query | Published Y/N | boolean |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
tag | query | Tags | array |
unpaged | query | boolean | |
user | query | User ID | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/{solutionId}/revision/{revisionId}/user/{userId}/deploy
Gets a page of deployments for the specified solution, revision and user IDs. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
revisionId | path | revisionId | string |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
userId | path | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
PUT /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Updates an existing deployment record with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
deploymentId | path | deploymentId | string |
revisionId | path | revisionId | string |
sd | body | sd | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/revision/{revisionId}/deploy/{deploymentId}
Deletes the deployment record with the specified IDs. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
deploymentId | path | deploymentId | string |
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
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
GET /solution/{solutionId}/rating
Gets a page of user ratings for the specified solution. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
solutionId | path | solutionId | string |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution
Creates a new solution 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. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/date
Finds published solutions based on specified catalog and date query parameters. Limits result to solutions, revisions, artifacts etc. modified after the specified time, expressed in milliseconds since the Epoch.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
ctlg | query | Catalog IDs | array |
inst | query | Milliseconds since the Epoch | integer |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{parentId}/comp/{childId}
Adds the specified member (child) to the specified composite solution (parent). Returns bad request if an ID is not found.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
childId | path | childId | string |
parentId | path | parentId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{parentId}/comp/{childId}
Removes the specified member (child) from the specified composite solution (parent).
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
childId | path | childId | string |
parentId | path | parentId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/tag
Gets all tags assigned to the specified solution ID. Answers empty if none are found.
- Produces: [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 object with a generated ID. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
artifactId | path | artifactId | string |
sd | body | sd | |
solutionId | path | solutionId | string |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/search/like
Searches for solutions with names or descriptions that contain the search term using the like operator. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
term | query | term | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/revision
Creates a new 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 |
---|---|---|---|
revision | body | revision | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision
Gets all revisions for the specified solution IDs. Answers empty if none are found.
- Produces: [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
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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
auth | query | Author key words | array |
desc | query | Description key words | array |
mtc | query | Model type codes | array |
name | query | Name key words | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
pub | query | Publisher key words | array |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
tag | query | Tags | array |
unpaged | query | boolean | |
user | query | User IDs | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search/portal/kwtag
Finds published 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
active | query | Active Y/N | boolean |
alltag | query | All tags, solution must have every one | array |
anytag | query | Any tags, solution must have at least one | array |
ctlg | query | Catalog IDs | array |
kw | query | Key words | array |
mtc | query | Model type codes | array |
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean | |
user | query | User IDs | array |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}
Updates an existing solution with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solution | body | solution | |
solutionId | path | solutionId | string |
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’]
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 null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}/rating/user/{userId}
Updates an existing solution rating 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 |
sr | body | sr | |
userId | path | userId | string |
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 |
sr | body | sr | |
userId | path | userId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
DELETE /solution/{solutionId}/rating/user/{userId}
Deletes the solution rating for the specified IDs. Returns bad request if not found.
- Produces: [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 the rating for the specified solution and user. Returns null if not found
- Produces: [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
PUT /solution/{solutionId}/pic
Saves or updates a solution image. Returns bad request if the ID is not found or the image is too large.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
picture | body | picture | |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/pic
Gets the image for the specified solution ID. Returns null if the ID is not found.
- Produces: [u’application/octet-stream’]
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}/dnld
Gets a page of download details for the specified solution’s artifacts. Returns empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
size | query | Number of records per page. | integer |
solutionId | path | solutionId | string |
sort | query | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /solution/{solutionId}/tag/{tag}
Adds the specified tag to the specified solution. Creates the tag if necessary. Returns bad request if the solution 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}
Removes the specified tag from the specified solution. Returns bad request if either is not found.
- Produces: [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/search/tag
Gets a page of solutions tagged with the specified tag. Answers empty if none are found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
offset | query | integer | |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
tag | query | tag | string |
unpaged | query | boolean |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
PUT /solution/{solutionId}/revision/{revisionId}
Updates an existing revision with the supplied data. Returns bad request on constraint violation etc.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revision | body | revision | |
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
400 - Bad request
DELETE /solution/{solutionId}/revision/{revisionId}
Deletes the revision with the specified ID. Cascades delete to related records. Returns bad request if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
403 - Forbidden
204 - No Content
401 - Unauthorized
400 - Bad request
GET /solution/{solutionId}/revision/{revisionId}
Gets the solution revision for the specified ID. Returns null if the ID is not found.
- Produces: [u’application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
revisionId | path | revisionId | string |
solutionId | path | solutionId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /solution/search
Searches for solutions 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’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
_j | query | Junction | string |
active | query | active | boolean |
modelTypeCode | query | modelTypeCode | string |
name | query | name | string |
offset | query | integer | |
origin | query | origin | string |
page | query | Results page you want to retrieve (0..N) | integer |
pageNumber | query | integer | |
pageSize | query | integer | |
paged | query | boolean | |
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 |
sort.sorted | query | boolean | |
sort.unsorted | query | boolean | |
sourceId | query | sourceId | string |
toolkitTypeCode | query | toolkitTypeCode | string |
unpaged | query | boolean | |
userId | query | userId | string |
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
CDS API in Athena Release¶
This section lists the methods in version 1.18.4, which is the last version in 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