{ "swagger": "2.0", "info": { "version": "1.7.2", "title": "App Center - Access Your External Tools" }, "paths": { "/ao-export": { "get": { "consumes": [ ], "produces": [ "application/octet-stream" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "string" } } } } }, "/app": { "get": { "description": "Lists all apps.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/apps": { "get": { "description": "This REST interface converts the given queryParam to an instance of AppsRequestDto, that contains the informations for querying AppDtos.\n AppsRequestDto contains the three groups 'types', 'labes' and 'keys'.\n While the elements per group will concatenated with OR, the groups itself will be concatenated with AND.\n <p>\n E.g. an AppsRequestDto containing types=['recommended', 'new'] and labels=['Mobile'] will result in ((recommended OR new) AND Mobile)", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "queryParam", "in": "query", "required": false, "default": "{}" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/appsmap": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "boolean", "name": "mandatoryApps", "in": "query", "required": true }, { "type": "boolean", "name": "newApps", "in": "query", "required": true }, { "type": "boolean", "name": "recommendedApps", "in": "query", "required": true }, { "type": "boolean", "name": "userApps", "in": "query", "required": true }, { "type": "boolean", "name": "visibleApps", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } } } } }, "/app/ids": { "get": { "description": "Searches apps by ids", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "array", "items": { "type": "integer" }, "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/keys": { "get": { "description": "Returns one app by its configured key", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "array", "items": { "type": "string" }, "name": "keys", "in": "query", "required": true, "description": "The key of the app to return" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/label/{label}": { "get": { "description": "Returns apps filtered by specified label", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "label", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/mandatory": { "get": { "description": "Lists all mandatory apps.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/new": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/recommended": { "get": { "description": "Lists all recommended apps.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/app/search": { "get": { "description": "Searches apps by title", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "searchString", "in": "query", "required": true, "description": "Title of search app for" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/applabel": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppLabelDto" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AppLabelDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/AppLabelDto" } } } } }, "/applabel/{id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/AppLabelDto" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AppLabelDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/AppLabelDto" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } } } } }, "/category": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/CategoryDto" } } } } }, "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CategoryDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/CategoryDto" } } } } }, "/category/order": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/category/{id}": { "put": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CategoryDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/CategoryDto" } } } }, "delete": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/configuration": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ConfigurationDto" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationDto" } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/cup/configuration": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "type": "string" } } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/export/category": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/CategoryDto" } } } } } }, "/export/html": { "get": { "consumes": [ ], "produces": [ "application/octet-stream" ], "parameters": [ { "type": "array", "items": { "type": "integer" }, "name": "categoryIds", "in": "query", "required": true }, { "type": "array", "items": { "type": "string" }, "name": "inclusions", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { "content-disposition": { "type": "string" } }, "schema": { "type": "string" } } } } }, "/i18n-plugin-configuration/category/{categoryId}": { "get": { "consumes": [ ], "produces": [ ], "parameters": [ { "type": "integer", "name": "categoryId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/I18nPluginConfiguration" } } } } }, "/i18n-plugin-configuration/label/{labelId}": { "get": { "consumes": [ ], "produces": [ ], "parameters": [ { "type": "integer", "name": "labelId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/I18nPluginConfiguration" } } } } }, "/userapp": { "get": { "description": "Lists all apps for the current user.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } } } } } }, "/userapp/{appId}": { "post": { "description": "Assigns a app to the current user.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "appId", "in": "path", "required": true, "description": "Id of the app which should be assigned to the user." } ], "responses": { "204": { "description": "No Content", "headers": { } } } }, "delete": { "description": "Removes the connection between the given app and the current user.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "appId", "in": "path", "required": true, "description": "Id of the app which should be assigned to the user." } ], "responses": { "204": { "description": "No Content", "headers": { } } } } } }, "definitions": { "AppDto": { "properties": { "appLabelIds": { "type": "array", "items": { "type": "integer" } }, "appLabels": { "type": "array", "items": { "$ref": "#/definitions/AppLabelDto" } }, "appLink": { "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#/definitions/CategoryDto" } }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "contact": { "type": "string" }, "contactFullname": { "type": "string" }, "contactUsername": { "type": "string" }, "customField": { "$ref": "#/definitions/CustomFieldDto" }, "description": { "type": "string" }, "displayedLabel": { "$ref": "#/definitions/AppLabelDto" }, "displayedLabelId": { "type": "integer" }, "hasIcon": { "type": "boolean" }, "id": { "type": "integer" }, "key": { "type": "string" }, "localizedAppLink": { "type": "string" }, "localizedDescription": { "type": "string" }, "localizedTitle": { "type": "string" }, "title": { "type": "string" } } }, "AppLabelDto": { "properties": { "id": { "type": "integer" }, "localizedName": { "type": "string" }, "name": { "type": "string" } } }, "CategoryDto": { "properties": { "appCount": { "type": "integer" }, "apps": { "type": "array", "items": { "$ref": "#/definitions/AppDto" } }, "children": { "type": "array", "items": { "$ref": "#/definitions/CategoryDto" } }, "fullName": { "type": "string" }, "id": { "type": "integer" }, "localizedFullName": { "type": "string" }, "localizedName": { "type": "string" }, "localizedParentName": { "type": "string" }, "name": { "type": "string" }, "parentId": { "type": "integer" }, "parentName": { "type": "string" }, "position": { "type": "integer" } } }, "ConfigurationDto": { "properties": { "customFieldEnabled": { "type": "boolean" }, "customFieldLabel": { "type": "string" }, "headerWebItemVisible": { "type": "boolean" }, "markAsNewEnabled": { "type": "boolean" }, "weeksToMarkAsNew": { "type": "integer" } } }, "CustomFieldDto": { "properties": { "label": { "type": "string" }, "localizedLabel": { "type": "string" }, "value": { "type": "string" } } }, "I18nPluginConfiguration": { "properties": { "fieldConfigurations": { "type": "object" }, "pluginKey": { "type": "string" } } } } }