Child pages
  • Launchpad - Developer Guide 2.0
Skip to end of metadata
Go to start of metadata

REST API

The stability of the REST API is not guaranteed.
{"openapi":"3.0.1","paths":{"/applabel/{id}":{"get":{"operationId":"getLabel","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"put":{"operationId":"updateLabel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppLabelDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"deleteLabel","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/applabel":{"get":{"operationId":"getLabels","responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"createLabel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppLabelDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/userapporder":{"put":{"operationId":"reOrderApps","parameters":[{"name":"leftNeighbourAppId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"appId","in":"query","schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserAppOrderDto"}}}}}}}},"/category/{id}":{"get":{"operationId":"getCategory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryWithAppsDto"}}}}}},"put":{"operationId":"updateCategory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryDto"}}}}}},"delete":{"operationId":"deleteCategory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/category":{"get":{"operationId":"getCategories","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDto"}}}}}}},"post":{"operationId":"createCategory","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryDto"}}}}}}},"/category/order":{"put":{"operationId":"saveCategoryOrder","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/configuration":{"get":{"operationId":"getConfiguration","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationDto"}}}}}},"put":{"operationId":"update","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/export/category":{"get":{"operationId":"getExportableCategories","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDto"}}}}}}}},"/export/html":{"get":{"operationId":"htmlExport","parameters":[{"name":"categoryIds","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"inclusions","in":"query","schema":{"type":"array","items":{"type":"string","enum":["MY_APPS","RECOMMENDED_APPS","UNCATEGORIZED_APPS"]}}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}}}},"/i18n-plugin-configuration/label/{labelId}":{"get":{"operationId":"getLabelConfig","parameters":[{"name":"labelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/I18nPluginConfiguration"}}}}}}},"/i18n-plugin-configuration/category/{categoryId}":{"get":{"operationId":"getCategoryConfig","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/I18nPluginConfiguration"}}}}}}},"/ao-export":{"get":{"operationId":"export","responses":{"default":{"description":"default response","content":{"application/octet-stream":{"schema":{"type":"string"}}}}}}},"/adminfilter/find":{"get":{"operationId":"getAdmins","parameters":[{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDto"}}}}}}}},"/app/ids":{"get":{"operationId":"getAppsByIds","parameters":[{"name":"id","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/appsmap":{"get":{"operationId":"getAppMap","parameters":[{"name":"mandatoryApps","in":"query","schema":{"type":"boolean"}},{"name":"recommendedApps","in":"query","schema":{"type":"boolean"}},{"name":"visibleApps","in":"query","schema":{"type":"boolean"}},{"name":"userApps","in":"query","schema":{"type":"boolean"}},{"name":"newApps","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}}},"/app/hasnewapps":{"get":{"operationId":"userHasNewApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/app/recommended":{"get":{"operationId":"getRecommendedApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/search":{"get":{"operationId":"findAppsByTitle","parameters":[{"name":"searchString","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/keys":{"get":{"operationId":"getAppsWithKeys","parameters":[{"name":"keys","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/apps":{"get":{"operationId":"getApps","parameters":[{"name":"queryParam","in":"query","schema":{"$ref":"#/components/schemas/AppsRequestDto"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/hasanyapps":{"get":{"operationId":"hasAnyApps","parameters":[{"name":"queryParam","in":"query","schema":{"$ref":"#/components/schemas/AppsRequestDto"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/app":{"get":{"operationId":"getVisibleApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/mandatory":{"get":{"operationId":"getMandatoryApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/new":{"get":{"operationId":"getNewApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/label/{label}":{"get":{"operationId":"getAppsByLabel","parameters":[{"name":"label","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/app/hasrecommendedapps":{"get":{"operationId":"userHasRecommendedApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/cup/configuration":{"get":{"operationId":"get","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}},"put":{"operationId":"update_1","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/userapp/{appId}":{"post":{"operationId":"addUserApp","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"deleteUserApp","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/userapp":{"get":{"operationId":"getUserApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}}},"/suggestApps/publish/{appId}":{"post":{"operationId":"publishSuggestedApp","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/suggestApps":{"get":{"operationId":"getSuggestedApps","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}}}}},"post":{"operationId":"createSuggestedApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestedAppDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/suggestApps/config/recipients":{"get":{"operationId":"getSuggestedAppsRecipients","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/suggestApps/enabled":{"get":{"operationId":"suggestAppsEnabled","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}}},"components":{"schemas":{"AppLabelDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"localizedName":{"type":"string"}},"xml":{"name":"applabel"}},"UserAppOrderDto":{"type":"object","properties":{"appId":{"type":"integer","format":"int64"},"orderPosition":{"type":"integer","format":"int32"}}},"CategoryDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"localizedName":{"type":"string"},"parentId":{"type":"integer","format":"int64"},"parentName":{"type":"string"},"localizedParentName":{"type":"string"},"appCount":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"},"fullName":{"type":"string"},"localizedFullName":{"type":"string"}}},"AppDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"title":{"type":"string"},"localizedTitle":{"type":"string"},"key":{"type":"string"},"description":{"type":"string"},"localizedDescription":{"type":"string"},"appLink":{"type":"string"},"localizedAppLink":{"type":"string"},"orderPosition":{"type":"integer","format":"int32"},"customField":{"$ref":"#/components/schemas/CustomFieldDto"},"base64Icon":{"type":"string"},"hasIcon":{"type":"boolean"},"updated":{"type":"string","format":"date-time"},"contact":{"type":"string"},"contactUser":{"$ref":"#/components/schemas/ConfluenceUser"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDto"}},"categoryIds":{"type":"array","items":{"type":"integer","format":"int64"}},"appLabels":{"type":"array","items":{"$ref":"#/components/schemas/AppLabelDto"}},"appLabelIds":{"type":"array","items":{"type":"integer","format":"int64"}},"displayedLabel":{"$ref":"#/components/schemas/AppLabelDto"},"displayedLabelId":{"type":"integer","format":"int64"},"recommended":{"type":"boolean"},"filtersForRecommendation":{"$ref":"#/components/schemas/FilterDto"},"mandatory":{"type":"boolean"},"filtersForMandate":{"$ref":"#/components/schemas/FilterDto"},"visibilityRestricted":{"type":"boolean"},"filtersForVisibility":{"$ref":"#/components/schemas/FilterDto"},"markAsNewEnabled":{"type":"boolean"},"creationDate":{"type":"string","format":"date-time"},"creatorUserKey":{"type":"string"},"creator":{"$ref":"#/components/schemas/ConfluenceUser"},"published":{"type":"boolean"},"contactUsername":{"type":"string"},"contactFullname":{"type":"string"},"creatorUsername":{"type":"string"},"creatorFullname":{"type":"string"},"labelsAsFormattedString":{"type":"string"},"categoriesAsFormattedString":{"type":"string"}}},"CategoryWithAppsDto":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategoryDto"},"apps":{"type":"array","items":{"$ref":"#/components/schemas/AppDto"}}}},"ConfluenceUser":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/UserKey"},"lowerName":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"}}},"CustomFieldDto":{"type":"object","properties":{"label":{"type":"string"},"localizedLabel":{"type":"string"},"value":{"type":"string"}}},"FilterDto":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"string"}}}},"UserKey":{"type":"object","properties":{"stringValue":{"type":"string"}}},"ConfigurationDto":{"type":"object","properties":{"headerWebItemVisible":{"type":"boolean"},"customFieldEnabled":{"type":"boolean"},"customFieldLabel":{"type":"string"},"enableAppSuggestions":{"type":"boolean"},"markAsNewEnabled":{"type":"boolean"},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/SuggestAppsRecipientDto"}},"weeksToMarkAsNew":{"type":"integer","format":"int32"}}},"Groupname":{"type":"object"},"SuggestAppsRecipientDto":{"type":"object","properties":{"type":{"type":"string","enum":["group","user"]},"id":{"type":"string"},"title":{"type":"string"},"groupname":{"$ref":"#/components/schemas/Groupname"},"userKey":{"$ref":"#/components/schemas/UserKey"},"thumbnailLink":{"$ref":"#/components/schemas/ThumbnailLink"}}},"ThumbnailLink":{"type":"object","properties":{"avatarUri":{"type":"string","format":"uri"}}},"I18nPluginConfiguration":{"type":"object","properties":{"pluginKey":{"type":"string"},"fieldConfigurations":{"type":"object"}}},"UserDto":{"type":"object","properties":{"userKey":{"type":"string"},"title":{"type":"string"},"avatarUrl":{"type":"string"},"type":{"type":"string"}}},"AppsRequestDto":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["NEW","RECOMMENDED","MANDATORY","UNKNOWN"]}},"labels":{"type":"array","items":{"type":"string"}},"keys":{"type":"array","items":{"type":"string"}}}},"SuggestedAppDto":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"appLink":{"type":"string"},"creator":{"type":"string"}}}}}}
  • No labels