UNPKG

@itentialopensource/adapter-jira

Version:

This adapter integrates with system Jira

1,670 lines (1,669 loc) 1.48 MB
{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/applicationrole": { "get": { "tags": [ "Applicationroles" ], "operationId": "getRestapi2applicationrole", "description": "The parameters and request body are for method: getRestapi2applicationrole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/applicationrole/{key}": { "get": { "tags": [ "Applicationroles" ], "operationId": "getRestapi2applicationrolekey", "description": "The parameters and request body are for method: getRestapi2applicationrolekey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "groups": { "type": "object" }, "name": { "type": "string" }, "defaultGroups": { "type": "object" }, "selectedByDefault": { "type": "boolean" }, "defined": { "type": "boolean" }, "numberOfSeats": { "type": "number" }, "remainingSeats": { "type": "number" }, "userCount": { "type": "number" }, "userCountDescription": { "type": "string" }, "hasUnlimitedSeats": { "type": "boolean" }, "platform": { "type": "boolean" } } }, "example": { "key": "in", "groups": [], "name": "Duis eiusmod", "defaultGroups": [], "selectedByDefault": false, "defined": true, "numberOfSeats": -543742, "remainingSeats": 97353986, "userCount": 55713618, "userCountDescription": "mollit", "hasUnlimitedSeats": true, "platform": true } } } } }, "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "title": "key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/auditing/record": { "get": { "tags": [ "Auditrecords" ], "operationId": "getRestapi2auditingrecord", "description": "The parameters and request body are for method: getRestapi2auditingrecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "number" }, "limit": { "type": "number" }, "total": { "type": "number" }, "records": { "type": "object" } } }, "example": { "offset": 4929371, "limit": 89248195, "total": 50005341, "records": [] } } } } }, "parameters": [ { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dashboard": { "get": { "tags": [ "Dashboards" ], "operationId": "getRestapi2dashboard", "description": "The parameters and request body are for method: getRestapi2dashboard. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "startAt": { "type": "number" }, "maxResults": { "type": "number" }, "total": { "type": "number" }, "prev": { "type": "string" }, "next": { "type": "string" }, "dashboards": { "type": "object" } } }, "example": { "startAt": -47030680, "maxResults": 51581726, "total": -30100979, "prev": "velit aliquip Duis", "next": "minim proident deserunt reprehenderit sed", "dashboards": [] } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "maxResults", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Dashboards" ], "operationId": "createDashboard", "description": "The parameters and request body are for method: createDashboard. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "isFavourite": { "type": "boolean" }, "name": { "type": "string" }, "popularity": { "type": "number" }, "self": { "type": "string" }, "sharePermissions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } }, "view": { "type": "string" } } }, "example": { "id": "10000", "isFavourite": false, "name": "System Dashboard", "popularity": 1, "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000", "sharePermissions": [ { "type": "global" } ], "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/dashboard/search": { "get": { "tags": [ "Dashboards" ], "operationId": "getRestapi2dashboardsearch", "description": "The parameters and request body are for method: getRestapi2dashboardsearch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "self": { "type": "string" }, "nextPage": { "type": "string" }, "maxResults": { "type": "number" }, "startAt": { "type": "number" }, "total": { "type": "number" }, "isLast": { "type": "boolean" }, "values": { "type": "object" } } }, "example": { "self": "https://yJihQinYGPSKUxmuyqZHrHyEXVpkOAZM.tqofqtF.e45", "nextPage": "https://NPIHReiLiTjNQiIqlpc.xhwMv+-rvuaKPVC1SaMAR0uNcMsJAGX.ww,fhle", "maxResults": -30980114, "startAt": 85027301, "total": -80944909, "isLast": true, "values": [] } } } } }, "parameters": [ { "name": "dashboardName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "owner", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "groupname", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "maxResults", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "expand", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dashboard/{dashboardId}/items/{itemId}/properties": { "get": { "tags": [ "Dashboards" ], "operationId": "getRestapi2dashboarddashboardIditemsitemIdproperties", "description": "The parameters and request body are for method: getRestapi2dashboarddashboardIditemsitemIdproperties. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "keys": { "type": "object" } } }, "example": { "keys": [] } } } } }, "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "title": "dashboardId", "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "title": "itemId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}": { "get": { "tags": [ "Dashboards" ], "operationId": "getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey", "description": "The parameters and request body are for method: getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "object", "properties": { "description": { "type": "string" } } } } }, "example": { "key": "ipsum reprehenderit amet", "value": { "description": "The value of the property. Required on create and update." } } } } } }, "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "title": "dashboardId", "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "title": "itemId", "type": "string" } }, { "name": "propertyKey", "in": "path", "required": true, "schema": { "title": "propertyKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Dashboards" ], "operationId": "putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey", "description": "The parameters and request body are for method: putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "title": "dashboardId", "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "title": "itemId", "type": "string" } }, { "name": "propertyKey", "in": "path", "required": true, "schema": { "title": "propertyKey", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Dashboards" ], "operationId": "deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey", "description": "The parameters and request body are for method: deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "title": "dashboardId", "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "title": "itemId", "type": "string" } }, { "name": "propertyKey", "in": "path", "required": true, "schema": { "title": "propertyKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dashboard/{id}": { "get": { "tags": [ "Dashboards" ], "operationId": "getRestapi2dashboardid", "description": "The parameters and request body are for method: getRestapi2dashboardid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "isFavourite": { "type": "boolean" }, "name": { "type": "string" }, "owner": { "type": "object", "properties": { "key": { "type": "string" }, "self": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "active": { "type": "boolean" }, "accountId": { "type": "string" }, "avatarUrls": { "type": "object", "properties": { "16x16": { "type": "string" }, "24x24": { "type": "string" }, "32x32": { "type": "string" }, "48x48": { "type": "string" } } } } }, "popularity": { "type": "number" }, "rank": { "type": "number" }, "self": { "type": "string" }, "sharePermissions": { "type": "object" }, "view": { "type": "string" } } }, "example": { "description": "amet et cillum nostrud fugiat", "id": "cillum non Ut id dolore", "isFavourite": true, "name": "magna", "owner": { "key": "do", "self": "http://MhHucQxZOagqPm.yenztjUSVsCNg8VGoLPZXLFnguPR,XaA.Y,R2rSt3bB7loYpMoXf", "name": "tempor nostrud ex", "displayName": "id ullamco Excepte", "active": true, "accountId": "irure anim reprehenderit mollit ea", "avatarUrls": { "16x16": "https://GdOyduVjFwoLvxM.gqF-yVvlX1B.BW9CV-tzKIYjwWh-pfsZMr.byyUnNgSOSvkJ4NDVKomT", "24x24": "http://EsSXLhNjQulEEjKad.fqkxQxVlAiLpGjrRUi4ee5M7onUycWtTAVmfR-21GHZ2lkln", "32x32": "http://oOxT.jcL5", "48x48": "http://CvYTScTDk.ioU5HRRK2eJx.EwyC3DeK+ZVzCw6VMM,DaEUq9Pg1vsNT" } }, "popularity": -84813416, "rank": 9171912, "self": "https://pbImsnXxqEZEfJm.spuzTt8MeG8qCTzYyve,st63Qng3vWy4hio", "sharePermissions": [], "view": "proident Lorem nisi officia" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Dashboards" ], "operationId": "updateDashboard", "description": "The parameters and request body are for method: updateDashboard. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "isFavourite": { "type": "boolean" }, "name": { "type": "string" }, "popularity": { "type": "number" }, "self": { "type": "string" }, "sharePermissions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } }, "view": { "type": "string" } } }, "example": { "id": "10000", "isFavourite": false, "name": "System Dashboard", "popularity": 1, "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000", "sharePermissions": [ { "type": "global" } ], "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Dashboards" ], "operationId": "deleteDashboard", "description": "The parameters and request body are for method: deleteDashboard. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/filter": { "get": { "tags": [ "Filters" ], "operationId": "getRestapi2filter", "description": "The parameters and request body are for method: getRestapi2filter. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "expand", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Filters" ], "operationId": "postRestapi2filter", "description": "The parameters and request body are for method: postRestapi2filter. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "self": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "object", "properties": { "self": { "type": "string" }, "key": { "type": "string" }, "accountId": { "type": "string" }, "accountType": { "type": "string" }, "name": { "type": "string" }, "emailAddress": { "type": "string" }, "avatarUrls": { "type": "object", "properties": { "16x16": { "type": "string" }, "24x24": { "type": "string" }, "32x32": { "type": "string" }, "48x48": { "type": "string" } } }, "displayName": { "type": "string" }, "active": { "type": "boolean" }, "timeZone": { "type": "string" }, "locale": { "type": "string" }, "groups": { "type": "object", "properties": { "size": { "type": "number" }, "items": { "type": "object" }, "pagingCallback": { "type": "object" }, "callback": { "type": "object" }, "max-results": { "type": "number" } } }, "applicationRoles": { "type": "object", "properties": { "size": { "type": "number" }, "items": { "type": "object" }, "pagingCallback": { "type": "object" }, "callback": { "type": "object" }, "max-results": { "type": "number" } } }, "expand": { "type": "string" } } }, "jql": { "type": "string" }, "viewUrl": { "type": "string" }, "searchUrl": { "type": "string" }, "favourite": { "type": "boolean" }, "favouritedCount": { "type": "number" }, "sharePermissions": { "type": "object" }, "sharedUsers": { "type": "object", "properties": { "size": { "type": "number" }, "items": { "type": "object" }, "max-results": { "type": "number" }, "start-index": { "type": "number" }, "end-index": { "type": "number" } } }, "subscriptions": { "type": "object", "properties": { "size": { "type": "number" }, "items": { "type": "object" }, "max-results": { "type": "number" }, "start-index": { "type": "number" }, "end-index": { "type": "number" } } } } }, "example": { "name": "sunt proident", "self": "https://nZaDksxncqlIerW.kgZQPlemHiEgR9Csx9EoLKhSthqSg", "id": "Ut sint", "description": "et ut fugiat Excepteur velit", "owner": { "self": "https://Sn.qnJF1u0VphcJyPhiURoTO0Jm4TqkbKf,INHAeHa.ckkdRHxRMaG6AVoBWC2z0DP", "key": "occaecat ea consequat", "accountId": "culpa esse", "accountType": "atlassian", "name": "officia", "emailAddress": "dolore", "avatarUrls": { "16x16": "https://esVISFggpyYMlDLNOTKSLEWkh.qjjpdE-YriXlbpJI31OOJu7,YJI52RznAnbmZI,9DlY91kou6sgEzuxcYAbvn", "24x24": "https://MBpOEIeSEWjlPXTZgYHNrw.dtgsMWtLw3kTsrAKTbig8yA.7H,63PWIcPVsjaDCRZ9", "32x32": "https://ztFeXAFMZZmwWvlibQ.lyotXru1ky2c", "48x48": "https://oYRtvVTshmjUcGlfcaNtlCTjuLyjFVt.isbqs6ZCHqES9Q52paL6z2tWcsBK2r5MGz3wrAIcDkJ8FXb8YeIwas7SMVXJn6u8NmVV9wNoIw7iC" }, "displayName": "aute aliquip", "active": true, "timeZone": "ut id eiusmod", "locale": "anim labore irure", "groups": { "size": -50583860, "items": [], "pagingCallback": {}, "callback": {}, "max-results": -32175536 }, "applicationRoles": { "size": -4658383, "items": [], "pagingCallback": {}, "callback": {}, "max-results": 31308471 }, "expand": "in" }, "jql": "in labore velit sunt nulla", "viewUrl": "https://uAqqIqmLVQJbcPXRPtKPJ.amlxHklyEJ058rFF", "searchUrl": "http://ZLvDLowiSJtkMf.ayoZaqpFhOHjoU3iP.7pScf3AcX6A,rhRe3,NofjzAwrl-Y-pbG1", "favourite": false, "favouritedCount": -61773425, "sharePermissions": [], "sharedUsers": { "size": 43907894, "items": [], "max-results": 82393329, "start-index": 82499401, "end-index": -79411442 }, "subscriptions": { "size": -91329331, "items": [], "max-results": 64898804, "start-index": 89929337, "end-index": -39284865 } } } } } }, "parameters": [ { "name": "expand", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/filter/favourite": { "get": { "tags": [ "Filters" ], "operationId": "getRestapi2filterfavourite", "description": "The parameters and request body are for method: getRestapi2filterfavourite. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "expand", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/filter/my": { "get": { "tags": [ "Filters" ], "operationId": "getRestapi2filtermy", "description": "The parameters and request body are for method: getRestapi2filtermy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "expand", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeFavourites", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/filter/search": { "get": { "tags": [ "Filters" ], "operationId": "getRestapi2filtersearch", "description": "The parameters and request body are for method: getRestapi2filtersearch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "self": { "type": "string" }, "nextPage": { "type": "string" }, "maxResults": { "type": "number" }, "startAt": { "type": "number" }, "total": { "type": "number" }, "isLast": { "type": "boolean" }, "values": { "type": "object" } } }, "example": { "self": "https://DRiEbNPUnK.isYPfTV7CArLGXEgPCCu-f1UiroMJiMrU6Cjuk,VXHnNgfPylw1xNNjbyJzMiT6", "nextPage": "https://vHritGnqgSLxIDsqLXayqpMJquNrG.ldrniG4YtPP", "maxResults": 81385001, "startAt": -87662561, "total": 69747235, "isLast": false, "values": [] } } } } }, "parameters": [ { "name": "filterName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "owner", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "groupname", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "maxResults", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "expand", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/filter/{id}": { "get": { "tags": [ "Filters" ], "operationId": "getRestapi2filterid", "description": "The parameters and request body are for method: getRestapi2filterid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "self": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "object", "properties": { "self": { "type": "string" }, "key": { "type": "string" }, "accountId": { "type": "string" }, "accountType": { "type": "string" }, "name": { "type": "string" }, "emailAddress": { "type": "string" }, "avatarUrls": { "type": "object", "properties": { "16x16": { "type": "string" }, "24x24": { "type": "string" }, "32x32": { "type": "string" }, "48x48": { "type": "string" } } }, "displayName": { "type": "string" }, "active": { "type": "boolean" }, "timeZone": { "type": "string" }, "locale": { "type": "string" }, "groups": { "type": "object", "properties": { "size": { "type": "number" }, "items": { "type": "object" }, "pagingCallback": { "type": "object" }, "callback": { "type": "object" }, "max-results": { "type": "number" }