...
name | type | required | description | example |
|---|---|---|---|---|
message | string | optional |
Project
name | type | required | description | example | |||
|---|---|---|---|---|---|---|---|
project | object | optional | metadata | object | optional | status message for the call (e.g. ok) |
ProjectConfiguration
name | type | required | description | example |
|---|---|---|---|---|
editPermission | boolean | optional | will be true to indicate that the user has edit permission | |
selectionItems | array[ #/definitions/SelectionItem ] | optional | list of selectable items (e.g. Project, Component, Version) | |
screen | string | optional | the selected project screen |
SearchParams
name | type | required | description | example | |
|---|---|---|---|---|---|
start | integer (int32) | optional | the user defined start (last start + limit) | ||
limit | integer (int32) | optional | the userdefined user defined limit (must be lower than 50 and higher than 25) | ||
returnAllFields | boolean | optional | default is false, so only the specified fields will be returned | ||
projectSearchValues | arraystring | optional | searchValues | project (key, name) releated search params | |
searchValues | object | optional | metadata releated search params |
SearchResult
name | type | required | description | example |
|---|---|---|---|---|
searchParams | optional | the used search params | ||
moreResultsAvailable | boolean | optional | indicates that even more values could be returned | |
results | optional | the search result |
SearchResultProjectItem
name | type | required | description | example |
|---|---|---|---|---|
project | object | optional | project related values (e.g. projectId, projectKey) | |
metadata | object | optional | the metadata as key value pairs |
SelectionItem
name | type | required | description | example |
|---|---|---|---|---|
label | string | optional | the label (e.g. Project, Component, Version, 1.0) | |
value | string | optional | the value (e.g. project, component, version, 1.0) | |
projectKey | string | optional | the project key | |
items | optional | list of selectable sub items (e.g. Version: 1.2, 1.3. 2.0) |