From 63e51dde83c907abc71de238253df69bf555222b Mon Sep 17 00:00:00 2001 From: Mike Turley Date: Wed, 14 Jun 2023 13:20:37 -0400 Subject: [PATCH 01/15] :ghost: Hack analysis: Add .java file extension and example markdown incident message for UI use (#400) Making incident mock data look a little more real for the UI demo Signed-off-by: Mike Turley --- hack/add/analysis.sh | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/hack/add/analysis.sh b/hack/add/analysis.sh index 2b0907a8..28f344e9 100755 --- a/hack/add/analysis.sh +++ b/hack/add/analysis.sh @@ -42,9 +42,20 @@ incidents: for n in $(seq 1 ${nIncident}) do f=$(($n%3)) -echo -n "- file: /thing.com/file/${i}${f} +echo -n "- file: /thing.com/file/${i}${f}.java line: ${n} - message: Thing happend line:${n} + message: | + This is a **description** of the issue on line ${n} *in markdown*. Here's how to fix the issue. + + For example: + + This is some bad code. + + Should become: + + This is some good code. + + Some documentation links will go here. facts: factA: ${i}-${n}.A factB: ${i}-${n}.B From 02f44520dc92eb179f36dbab73164c9d13e92274 Mon Sep 17 00:00:00 2001 From: Samuel Lucidi Date: Wed, 14 Jun 2023 16:10:28 -0400 Subject: [PATCH 02/15] :warning: Update Fact API to use qualified keys (source:fact) (#396) Get/replace/delete an anonymous fact GET/PUT/DELETE /application/1/facts/myfact Get/replace/delete a qualified fact GET/PUT/DELETE /application/1/facts/mysource:myotherfact List and replace for anonymous source: GET/PUT /application/1/facts List and replace all by source GET/PUT /application/1/facts/mysource: --------- Signed-off-by: Sam Lucidi --- addon/application.go | 49 +++-- api/api_test.go | 40 ++++ api/application.go | 236 ++++++++++++---------- docs/docs.go | 171 ++++++++-------- docs/index.html | 307 ++++++++++++++++------------- docs/swagger.json | 171 ++++++++-------- docs/swagger.yaml | 136 +++++++------ hack/add/fact.sh | 4 +- hack/cmd/addon/main.go | 7 + test/api/application/facts_test.go | 19 +- 10 files changed, 611 insertions(+), 529 deletions(-) diff --git a/addon/application.go b/addon/application.go index a8e3b2cf..99d6edac 100644 --- a/addon/application.go +++ b/addon/application.go @@ -223,47 +223,52 @@ func (h *AppFacts) Source(source string) { // // List facts. -func (h *AppFacts) List() (list []api.Fact, err error) { - list = []api.Fact{} - path := Path(api.ApplicationFactsRoot).Inject(Params{api.ID: h.appId}) - err = h.client.Get(path, &list, Param{Key: api.Source, Value: h.source}) +func (h *AppFacts) List() (facts api.FactMap, err error) { + facts = api.FactMap{} + key := api.FactKey("") + key.Qualify(h.source) + path := Path(api.ApplicationFactsRoot).Inject(Params{api.ID: h.appId, api.Key: key}) + err = h.client.Get(path, &facts) return } // // Get a fact. -func (h *AppFacts) Get(key string) (fact *api.Fact, err error) { +func (h *AppFacts) Get(name string, value interface{}) (err error) { + key := api.FactKey(name) + key.Qualify(h.source) path := Path(api.ApplicationFactRoot).Inject( Params{ - api.ID: h.appId, - api.Key: key, - api.Source: h.source, + api.ID: h.appId, + api.Key: key, }) - err = h.client.Get(path, fact) + err = h.client.Get(path, value) return } // // Set a fact (created as needed). -func (h *AppFacts) Set(key string, value interface{}) (err error) { +func (h *AppFacts) Set(name string, value interface{}) (err error) { + key := api.FactKey(name) + key.Qualify(h.source) path := Path(api.ApplicationFactRoot).Inject( Params{ - api.ID: h.appId, - api.Key: key, - api.Source: h.source, + api.ID: h.appId, + api.Key: key, }) - err = h.client.Put(path, api.Fact{Value: value}) + err = h.client.Put(path, value) return } // // Delete a fact. -func (h *AppFacts) Delete(key string) (err error) { +func (h *AppFacts) Delete(name string) (err error) { + key := api.FactKey(name) + key.Qualify(h.source) path := Path(api.ApplicationFactRoot).Inject( Params{ - api.ID: h.appId, - api.Key: key, - api.Source: h.source, + api.ID: h.appId, + api.Key: key, }) err = h.client.Delete(path) return @@ -271,9 +276,11 @@ func (h *AppFacts) Delete(key string) (err error) { // // Replace facts. -func (h *AppFacts) Replace(facts []api.Fact) (err error) { - path := Path(api.ApplicationFactsRoot).Inject(Params{api.ID: h.appId}) - err = h.client.Put(path, facts, Param{Key: api.Source, Value: h.source}) +func (h *AppFacts) Replace(facts api.FactMap) (err error) { + key := api.FactKey("") + key.Qualify(h.source) + path := Path(api.ApplicationFactsRoot).Inject(Params{api.ID: h.appId, api.Key: key}) + err = h.client.Put(path, facts) return } diff --git a/api/api_test.go b/api/api_test.go index 03ffebe0..09a314a3 100644 --- a/api/api_test.go +++ b/api/api_test.go @@ -32,3 +32,43 @@ func TestAccepted(t *testing.T) { ctx.Request.Header[Accept] = []string{"x/y,a/b;q=1.0"} g.Expect(h.Accepted(ctx, "a/b")).To(gomega.BeTrue()) } + +func TestFactKey(t *testing.T) { + g := gomega.NewGomegaWithT(t) + + key := FactKey("key") + g.Expect(key.Source()).To(gomega.Equal("")) + g.Expect(key.Name()).To(gomega.Equal("key")) + + key = FactKey("test:key") + g.Expect(key.Source()).To(gomega.Equal("test")) + g.Expect(key.Name()).To(gomega.Equal("key")) + + key = FactKey(":key") + g.Expect(key.Source()).To(gomega.Equal("")) + g.Expect(key.Name()).To(gomega.Equal("key")) + + key = FactKey("test:") + g.Expect(key.Source()).To(gomega.Equal("test")) + g.Expect(key.Name()).To(gomega.Equal("")) + + key = FactKey("") + key.Qualify("test") + g.Expect(key.Source()).To(gomega.Equal("test")) + g.Expect(key.Name()).To(gomega.Equal("")) + + key = FactKey("key") + key.Qualify("test") + g.Expect(key.Source()).To(gomega.Equal("test")) + g.Expect(key.Name()).To(gomega.Equal("key")) + + key = FactKey("source:key") + key.Qualify("test") + g.Expect(key.Source()).To(gomega.Equal("test")) + g.Expect(key.Name()).To(gomega.Equal("key")) + + key = FactKey("source:") + key.Qualify("test") + g.Expect(key.Source()).To(gomega.Equal("test")) + g.Expect(key.Name()).To(gomega.Equal("")) +} diff --git a/api/application.go b/api/application.go index c35419c1..4a867ff6 100644 --- a/api/application.go +++ b/api/application.go @@ -2,12 +2,11 @@ package api import ( "encoding/json" - "errors" "github.com/gin-gonic/gin" "github.com/konveyor/tackle2-hub/model" - "gorm.io/gorm" "gorm.io/gorm/clause" "net/http" + "strings" ) // @@ -18,7 +17,7 @@ const ( ApplicationTagsRoot = ApplicationRoot + "/tags" ApplicationTagRoot = ApplicationTagsRoot + "/:" + ID2 ApplicationFactsRoot = ApplicationRoot + "/facts" - ApplicationFactRoot = ApplicationFactsRoot + "/:" + Key + "/*" + Source + ApplicationFactRoot = ApplicationFactsRoot + "/:" + Key AppBucketRoot = ApplicationRoot + "/bucket" AppBucketContentRoot = AppBucketRoot + "/*" + Wildcard AppStakeholdersRoot = ApplicationRoot + "/stakeholders" @@ -59,13 +58,13 @@ func (h ApplicationHandler) AddRoutes(e *gin.Engine) { // Facts routeGroup = e.Group("/") routeGroup.Use(Required("applications.facts")) - routeGroup.GET(ApplicationFactsRoot, h.FactList) - routeGroup.GET(ApplicationFactsRoot+"/", h.FactList) + routeGroup.GET(ApplicationFactsRoot, h.FactGet) + routeGroup.GET(ApplicationFactsRoot+"/", h.FactGet) routeGroup.POST(ApplicationFactsRoot, h.FactCreate) routeGroup.GET(ApplicationFactRoot, h.FactGet) routeGroup.PUT(ApplicationFactRoot, h.FactPut) routeGroup.DELETE(ApplicationFactRoot, h.FactDelete) - routeGroup.PUT(ApplicationFactsRoot, h.FactReplace, Transaction) + routeGroup.PUT(ApplicationFactsRoot, h.FactPut, Transaction) // Bucket routeGroup = e.Group("/") routeGroup.Use(Required("applications.bucket")) @@ -560,54 +559,46 @@ func (h ApplicationHandler) TagDelete(ctx *gin.Context) { // FactList godoc // @summary List facts. -// @description List facts. Can be filtered by source. -// @description By default facts from all sources are returned. +// @description List facts by source. +// @description see api.FactKey for details on key parameter format. // @tags applications // @produce json -// @success 200 {object} []api.Fact -// @router /applications/{id}/facts [get] +// @success 200 {object} api.FactMap +// @router /applications/{id}/facts/{source}: [get] // @param id path string true "Application ID" -// @param source query string false "Fact source" -func (h ApplicationHandler) FactList(ctx *gin.Context) { +// @param source path string true "Source key" +func (h ApplicationHandler) FactList(ctx *gin.Context, key FactKey) { id := h.pk(ctx) - app := &model.Application{} - result := h.DB(ctx).First(app, id) - if result.Error != nil { - _ = ctx.Error(result.Error) - return - } - - db := h.DB(ctx) - source, found := ctx.GetQuery(Source) - if found { - condition := h.DB(ctx).Where("source = ?", source) - db = db.Where(condition) - } list := []model.Fact{} - result = db.Find(&list, "ApplicationID = ?", id) + db := h.DB(ctx) + db = db.Where("ApplicationID", id) + db = db.Where("Source", key.Source()) + result := db.Find(&list) if result.Error != nil { _ = ctx.Error(result.Error) return } - resources := []Fact{} + + facts := FactMap{} for i := range list { - r := Fact{} - r.With(&list[i]) - resources = append(resources, r) + fact := &list[i] + var v interface{} + _ = json.Unmarshal(fact.Value, &v) + facts[fact.Key] = v } - h.Respond(ctx, http.StatusOK, resources) + h.Respond(ctx, http.StatusOK, facts) } // FactGet godoc // @summary Get fact by name. // @description Get fact by name. +// @description see api.FactKey for details on key parameter format. // @tags applications // @produce json -// @success 200 {object} api.Fact -// @router /applications/{id}/facts/{name}/{source} [get] +// @success 200 {object} object +// @router /applications/{id}/facts/{key} [get] // @param id path string true "Application ID" // @param key path string true "Fact key" -// @param source path string true "Fact source" func (h ApplicationHandler) FactGet(ctx *gin.Context) { id := h.pk(ctx) app := &model.Application{} @@ -616,10 +607,19 @@ func (h ApplicationHandler) FactGet(ctx *gin.Context) { _ = ctx.Error(result.Error) return } - key := ctx.Param(Key) - source := ctx.Param(Source)[1:] + + key := FactKey(ctx.Param(Key)) + if key.Name() == "" { + h.FactList(ctx, key) + return + } + list := []model.Fact{} - result = h.DB(ctx).Find(&list, "ApplicationID = ? AND Key = ? AND source = ?", id, key, source) + db := h.DB(ctx) + db = db.Where("ApplicationID", id) + db = db.Where("Source", key.Source()) + db = db.Where("Key", key.Name()) + result = db.Find(&list) if result.Error != nil { _ = ctx.Error(result.Error) return @@ -628,9 +628,10 @@ func (h ApplicationHandler) FactGet(ctx *gin.Context) { h.Status(ctx, http.StatusNotFound) return } - r := Fact{} - r.With(&list[0]) - h.Respond(ctx, http.StatusOK, r) + + var v interface{} + _ = json.Unmarshal(list[0].Value, &v) + h.Respond(ctx, http.StatusOK, v) } // FactCreate godoc @@ -672,6 +673,7 @@ func (h ApplicationHandler) FactCreate(ctx *gin.Context) { // FactPut godoc // @summary Update (or create) a fact. // @description Update (or create) a fact. +// @description see api.FactKey for details on key parameter format. // @tags applications // @accept json // @produce json @@ -679,16 +681,9 @@ func (h ApplicationHandler) FactCreate(ctx *gin.Context) { // @router /applications/{id}/facts/{key} [put] // @param id path string true "Application ID" // @param key path string true "Fact key" -// @param source path string true "Fact source" -// @param fact body api.Fact true "Fact data" +// @param fact body object true "Fact value" func (h ApplicationHandler) FactPut(ctx *gin.Context) { id := h.pk(ctx) - r := &Fact{} - err := h.Bind(ctx, &r) - if err != nil { - _ = ctx.Error(err) - return - } app := &model.Application{} result := h.DB(ctx).First(app, id) if result.Error != nil { @@ -696,51 +691,43 @@ func (h ApplicationHandler) FactPut(ctx *gin.Context) { return } - key := ctx.Param(Key) - source := ctx.Param(Source)[1:] - value, _ := json.Marshal(r.Value) - result = h.DB(ctx).First(&model.Fact{}, "ApplicationID = ? AND Key = ? AND source = ?", id, key, source) - if result.Error == nil { - result = h.DB(ctx). - Model(&model.Fact{}). - Where("ApplicationID = ? AND Key = ? AND source = ?", id, key, source). - Update("Value", value) - if result.Error != nil { - _ = ctx.Error(result.Error) - return - } - h.Status(ctx, http.StatusNoContent) + key := FactKey(ctx.Param(Key)) + if key.Name() == "" { + h.FactReplace(ctx, key) return } - if errors.Is(result.Error, gorm.ErrRecordNotFound) { - m := &model.Fact{ - Key: Key, - Source: source, - ApplicationID: id, - Value: value, - } - db := h.DB(ctx) - db = db.Clauses(clause.OnConflict{UpdateAll: true}) - result = db.Create(m) - if result.Error != nil { - _ = ctx.Error(result.Error) - return - } - h.Status(ctx, http.StatusNoContent) - } else { + f := Fact{} + err := h.Bind(ctx, &f.Value) + if err != nil { + _ = ctx.Error(err) + return + } + + value, _ := json.Marshal(f.Value) + m := &model.Fact{ + Key: key.Name(), + Source: key.Source(), + ApplicationID: id, + Value: value, + } + db := h.DB(ctx) + result = db.Save(m) + if result.Error != nil { _ = ctx.Error(result.Error) + return } + h.Status(ctx, http.StatusNoContent) } // FactDelete godoc // @summary Delete a fact. // @description Delete a fact. +// @description see api.FactKey for details on key parameter format. // @tags applications // @success 204 -// @router /applications/{id}/facts/{key}/{source} [delete] +// @router /applications/{id}/facts/{key} [delete] // @param id path string true "Application ID" // @param key path string true "Fact key" -// @param source path string true "Fact source" func (h ApplicationHandler) FactDelete(ctx *gin.Context) { id := h.pk(ctx) app := &model.Application{} @@ -750,9 +737,12 @@ func (h ApplicationHandler) FactDelete(ctx *gin.Context) { return } fact := &model.Fact{} - key := ctx.Param(Key) - source := ctx.Param(Source)[1:] - result = h.DB(ctx).Delete(fact, "ApplicationID = ? AND Key = ? AND source = ?", id, key, source) + key := FactKey(ctx.Param(Key)) + db := h.DB(ctx) + db = db.Where("ApplicationID", id) + db = db.Where("Source", key.Source()) + db = db.Where("Key", key.Name()) + result = db.Delete(fact) if result.Error != nil { _ = ctx.Error(result.Error) return @@ -764,34 +754,26 @@ func (h ApplicationHandler) FactDelete(ctx *gin.Context) { // FactReplace godoc // @summary Replace all facts from a source. // @description Replace all facts from a source. +// @description see api.FactKey for details on key parameter format. // @tags applications // @success 204 -// @router /applications/{id}/facts [put] +// @router /applications/{id}/facts/{source}: [put] // @param id path string true "Application ID" -// @param source query string true "Source" -func (h ApplicationHandler) FactReplace(ctx *gin.Context) { - source := ctx.Query(Source) - if source == "" { - _ = ctx.Error(&BadRequestError{Reason: "`source` query parameter is required"}) - return - } - facts := []Fact{} +// @param source path string true "Fact key" +// @param factmap body api.FactMap true "Fact map" +func (h ApplicationHandler) FactReplace(ctx *gin.Context, key FactKey) { + id := h.pk(ctx) + facts := FactMap{} err := h.Bind(ctx, &facts) if err != nil { _ = ctx.Error(err) return } - id := h.pk(ctx) - app := &model.Application{} - result := h.DB(ctx).First(app, id) - if result.Error != nil { - _ = ctx.Error(result.Error) - return - } - // remove all the existing Facts for that source and app id. - db := h.DB(ctx).Where("ApplicationID = ?", id).Where("source = ?", source) + db := h.DB(ctx) + db = db.Where("ApplicationID", id) + db = db.Where("Source", key.Source()) err = db.Delete(&model.Fact{}).Error if err != nil { _ = ctx.Error(err) @@ -801,13 +783,13 @@ func (h ApplicationHandler) FactReplace(ctx *gin.Context) { // create new Facts if len(facts) > 0 { newFacts := []model.Fact{} - for _, f := range facts { - value, _ := json.Marshal(f.Value) + for k, v := range facts { + value, _ := json.Marshal(v) newFacts = append(newFacts, model.Fact{ ApplicationID: id, - Key: f.Key, + Key: FactKey(k).Name(), Value: value, - Source: source, + Source: key.Source(), }) } err = db.Create(&newFacts).Error @@ -1006,6 +988,50 @@ func (r *Fact) Model() (m *model.Fact) { return } +// +// FactKey is a fact source and fact name separated by a colon. +// Example: 'analysis:languages' +// +// A FactKey can be used to identify an anonymous fact. +// Example: 'languages' or ':languages' +// +// A FactKey can also be used to identify just a source. This use must include the trailing +// colon to distinguish it from an anonymous fact. This is used when listing or replacing +// all facts that belong to a source. +// Example: 'analysis:" +type FactKey string + +// +// Qualify qualifies the name with the source. +func (r *FactKey) Qualify(source string) { + *r = FactKey( + strings.Join( + []string{source, r.Name()}, + ":")) +} + +// +// Source returns the source portion of a fact key. +func (r FactKey) Source() (source string) { + s, _, found := strings.Cut(string(r), ":") + if found { + source = s + } + return +} + +// +// Name returns the name portion of a fact key. +func (r FactKey) Name() (name string) { + _, n, found := strings.Cut(string(r), ":") + if found { + name = n + } else { + name = string(r) + } + return +} + // // Stakeholders REST subresource. type Stakeholders struct { diff --git a/docs/docs.go b/docs/docs.go index f2382cce..6defa127 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -686,15 +686,18 @@ const docTemplate = `{ } }, "/applications/{id}/facts": { - "get": { - "description": "List facts. Can be filtered by source.\nBy default facts from all sources are returned.", + "post": { + "description": "Create a fact.", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], "tags": [ "applications" ], - "summary": "List facts.", + "summary": "Create a fact.", "parameters": [ { "type": "string", @@ -704,64 +707,32 @@ const docTemplate = `{ "required": true }, { - "type": "string", - "description": "Fact source", - "name": "source", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", + "description": "Fact data", + "name": "fact", + "in": "body", + "required": true, "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/api.Fact" - } + "$ref": "#/definitions/api.Fact" } } - } - }, - "put": { - "description": "Replace all facts from a source.", - "tags": [ - "applications" - ], - "summary": "Replace all facts from a source.", - "parameters": [ - { - "type": "string", - "description": "Application ID", - "name": "id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Source", - "name": "source", - "in": "query", - "required": true - } ], "responses": { - "204": { - "description": "No Content" + "201": { + "description": "Created" } } - }, - "post": { - "description": "Create a fact.", - "consumes": [ - "application/json" - ], + } + }, + "/applications/{id}/facts/{key}": { + "get": { + "description": "Get fact by name.\nsee api.FactKey for details on key parameter format.", "produces": [ "application/json" ], "tags": [ "applications" ], - "summary": "Create a fact.", + "summary": "Get fact by name.", "parameters": [ { "type": "string", @@ -771,25 +742,24 @@ const docTemplate = `{ "required": true }, { - "description": "Fact data", - "name": "fact", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/api.Fact" - } + "type": "string", + "description": "Fact key", + "name": "key", + "in": "path", + "required": true } ], "responses": { - "201": { - "description": "Created" + "200": { + "description": "OK", + "schema": { + "type": "object" + } } } - } - }, - "/applications/{id}/facts/{key}": { + }, "put": { - "description": "Update (or create) a fact.", + "description": "Update (or create) a fact.\nsee api.FactKey for details on key parameter format.", "consumes": [ "application/json" ], @@ -816,19 +786,12 @@ const docTemplate = `{ "required": true }, { - "type": "string", - "description": "Fact source", - "name": "source", - "in": "path", - "required": true - }, - { - "description": "Fact data", + "description": "Fact value", "name": "fact", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/api.Fact" + "type": "object" } } ], @@ -837,11 +800,9 @@ const docTemplate = `{ "description": "No Content" } } - } - }, - "/applications/{id}/facts/{key}/{source}": { + }, "delete": { - "description": "Delete a fact.", + "description": "Delete a fact.\nsee api.FactKey for details on key parameter format.", "tags": [ "applications" ], @@ -860,13 +821,6 @@ const docTemplate = `{ "name": "key", "in": "path", "required": true - }, - { - "type": "string", - "description": "Fact source", - "name": "source", - "in": "path", - "required": true } ], "responses": { @@ -876,16 +830,16 @@ const docTemplate = `{ } } }, - "/applications/{id}/facts/{name}/{source}": { + "/applications/{id}/facts/{source}:": { "get": { - "description": "Get fact by name.", + "description": "List facts by source.\nsee api.FactKey for details on key parameter format.", "produces": [ "application/json" ], "tags": [ "applications" ], - "summary": "Get fact by name.", + "summary": "List facts.", "parameters": [ { "type": "string", @@ -896,25 +850,55 @@ const docTemplate = `{ }, { "type": "string", - "description": "Fact key", - "name": "key", + "description": "Source key", + "name": "source", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/api.FactMap" + } + } + } + }, + "put": { + "description": "Replace all facts from a source.\nsee api.FactKey for details on key parameter format.", + "tags": [ + "applications" + ], + "summary": "Replace all facts from a source.", + "parameters": [ + { + "type": "string", + "description": "Application ID", + "name": "id", "in": "path", "required": true }, { "type": "string", - "description": "Fact source", + "description": "Fact key", "name": "source", "in": "path", "required": true + }, + { + "description": "Fact map", + "name": "factmap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/api.FactMap" + } } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/api.Fact" - } + "204": { + "description": "No Content" } } } @@ -5861,8 +5845,7 @@ const docTemplate = `{ "type": "string", "enum": [ "jira-cloud", - "jira-server", - "jira-datacenter" + "jira-onprem" ] }, "lastUpdated": { diff --git a/docs/index.html b/docs/index.html index 8ad1e990..c1db2ab6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1793,7 +1793,9 @@ data-styled.g18[id="sc-hBMUJo"]{content:"iwcKgn,"}/*!sc*/ .eQzShU{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/ .eQzShU.deprecated{-webkit-text-decoration:line-through;text-decoration:line-through;color:#707070;}/*!sc*/ -data-styled.g20[id="sc-fFSPTT"]{content:"eQzShU,"}/*!sc*/ +.fcIjHV{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;font-style:italic;}/*!sc*/ +.fcIjHV.deprecated{-webkit-text-decoration:line-through;text-decoration:line-through;color:#707070;}/*!sc*/ +data-styled.g20[id="sc-fFSPTT"]{content:"eQzShU,fcIjHV,"}/*!sc*/ .ctPuOP{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/ tr.expanded .sc-bkbkJK{border-bottom:none;}/*!sc*/ @media screen and (max-width:50rem){.ctPuOP{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last > .sc-bkbkJK{border-left:none;}}/*!sc*/ @@ -2096,7 +2098,7 @@ -
Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application dependencies.

List application dependencies. filters:

    -
  • id
  • name
  • version
  • -
  • type
  • sha
  • indirect
  • +
  • labels
path Parameters
id
required
string

Application ID

Responses

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application issues.

List application issues. filters:

    -
  • id
  • -
  • ruleid
  • +
  • ruleset
  • +
  • rule
  • name
  • category
  • effort
  • +
  • labels
path Parameters
id
required
string

Application ID

Responses

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issuereports

List issue reports.

Each report collates issues by ruleset/rule and application. +

Response samples

Content type
application/json
[
  • {
    }
]

appreports

List application reports.

List application reports. filters:

    -
  • ruleset
  • -
  • rule
  • +
  • id
  • name
  • -
  • category
  • +
  • description
  • +
  • businessService
  • effort
  • -
  • labels
  • -
  • application.(id|name)
  • -
  • tag.id
  • +
  • incidents
  • +
  • files
  • +
  • issue.id
  • +
  • issue.name
  • +
  • issue.ruleset
  • +
  • issue.rule
  • +
  • issue.category
  • +
  • issue.effort
  • +
  • issue.labels
  • +
  • application.id
  • +
  • application.name
  • +
  • businessService.name +sort:
  • +
  • id
  • +
  • name
  • +
  • description
  • +
  • businessService
  • +
  • effort
  • +
  • incidents
  • +
  • files

Responses

Response samples

Content type
application/json
[
  • {
    }
]

filereports

List incident file reports.

Each report collates incidents by file. +

Response samples

Content type
application/json
[
  • {
    }
]

filereports

List incident file reports.

Each report collates incidents by file. filters:

  • file
  • effort
  • +
  • incidents +sort:
  • +
  • file
  • +
  • effort
  • incidents

Responses

Responses

Response samples

Content type
application/json
[
  • {
    }
]

applications

List all applications.

List all applications.

@@ -2272,102 +2309,104 @@

Delete bucket content by ID and path.

Delete bucket content by ID and path.

path Parameters
id
required
string

Application ID

Responses

List facts.

List facts. Can be filtered by source. -By default facts from all sources are returned.

-
path Parameters
id
required
string

Application ID

-
query Parameters
source
string

Fact source

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Replace all facts from a source.

Replace all facts from a source.

-
path Parameters
id
required
string

Application ID

-
query Parameters
source
required
string

Source

-

Responses

Create a fact.

Create a fact.

+

Create a fact.

Create a fact.

path Parameters
id
required
string

Application ID

Request Body schema: application/json

Fact data

key
string
source
string
value
any

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "source": "string",
  • "value": null
}

Update (or create) a fact.

Update (or create) a fact.

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "source": "string",
  • "value": null
}

Get fact by name.

Get fact by name. +see api.FactKey for details on key parameter format.

path Parameters
id
required
string

Application ID

-
key
required
string

Fact key

-
source
required
string

Fact source

-
Request Body schema: application/json

Fact data

-
key
string
source
string
value
any

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "source": "string",
  • "value": null
}

Delete a fact.

Delete a fact.

+
key
required
string

Fact key

+

Responses

Response samples

Content type
application/json
{ }

Update (or create) a fact.

Update (or create) a fact. +see api.FactKey for details on key parameter format.

path Parameters
id
required
string

Application ID

-
key
required
string

Fact key

-
source
required
string

Fact source

+
key
required
string

Fact key

+
Request Body schema: application/json

Fact value

+
object

Responses

Request samples

Content type
application/json
{ }

Delete a fact.

Delete a fact. +see api.FactKey for details on key parameter format.

+
path Parameters
id
required
string

Application ID

+
key
required
string

Fact key

Responses

Get fact by name.

Get fact by name.

+

List facts.

List facts by source. +see api.FactKey for details on key parameter format.

path Parameters
id
required
string

Application ID

-
key
required
string

Fact key

-
source
required
string

Fact source

+
source
required
string

Source key

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "source": "string",
  • "value": null
}

Update the owner and contributors of an Application.

Update the owner and contributors of an Application.

+

Response samples

Content type
application/json
{ }

Replace all facts from a source.

Replace all facts from a source. +see api.FactKey for details on key parameter format.

+
path Parameters
id
required
string

Application ID

+
source
required
string

Fact key

+
Request Body schema: application/json

Fact map

+
property name*
any

Responses

Request samples

Content type
application/json
{ }

Update the owner and contributors of an Application.

Update the owner and contributors of an Application.

path Parameters
id
required
integer

Application ID

Request Body schema: application/json

Application stakeholders

Array of objects (api.Ref) [ items ]
object (api.Ref)

Responses

Request samples

Content type
application/json
{
  • "contributors": [
    ],
  • "owner": {
    }
}

Add tag association.

Ensure tag is associated with the application.

+

Request samples

Content type
application/json
{
  • "contributors": [
    ],
  • "owner": {
    }
}

Add tag association.

Ensure tag is associated with the application.

Request Body schema: application/json

Tag data

id
required
integer
name
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Replace tag associations.

Replace tag associations.

+

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Replace tag associations.

Replace tag associations.

path Parameters
id
required
string

Application ID

query Parameters
source
string

Source

Request Body schema: application/json

Tag references

Array
id
required
integer
name
string
source
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

List tag references.

List tag references.

+

Request samples

Content type
application/json
[
  • {
    }
]

List tag references.

List tag references.

path Parameters
id
required
string

Application ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete tag association.

Ensure tag is not associated with the application.

+

Response samples

Content type
application/json
[
  • {
    }
]

Delete tag association.

Ensure tag is not associated with the application.

path Parameters
id
required
string

Application ID

sid
required
string

Tag ID

Responses

auth

Login and obtain a bearer token.

Login and obtain a bearer token.

Responses

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

Refresh bearer token.

Refresh bearer token.

+

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

Refresh bearer token.

Refresh bearer token.

Responses

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

batch

Batch-create Tags.

Batch-create Tags.

+

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

batch

Batch-create Tags.

Batch-create Tags.

Request Body schema: application/json

Tags data

Array
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Batch-create Tickets.

Batch-create Tickets.

+

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Batch-create Tickets.

Batch-create Tickets.

Request Body schema: application/json

Tickets data

Array
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

tags

Batch-create Tags.

Batch-create Tags.

+

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

tags

Batch-create Tags.

Batch-create Tags.

Request Body schema: application/json

Tags data

Array
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tags.

List all tags.

+

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tags.

List all tags.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag.

Create a tag.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag.

Create a tag.

Request Body schema: application/json

Tag data

required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Get a tag by ID.

Get a tag by ID.

+

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Get a tag by ID.

Get a tag by ID.

path Parameters
id
required
string

Tag ID

Responses

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Update a tag.

Update a tag.

+

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Update a tag.

Update a tag.

path Parameters
id
required
string

Tag ID

Request Body schema: application/json

Tag data

required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Delete a tag.

Delete a tag.

+

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Delete a tag.

Delete a tag.

path Parameters
id
required
string

Tag ID

Responses

tickets

Batch-create Tickets.

Batch-create Tickets.

Request Body schema: application/json

Tickets data

Array
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tickets.

List all tickets.

+

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tickets.

List all tickets.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ticket.

Create a ticket.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a ticket.

Create a ticket.

Request Body schema: application/json

Ticket data

required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Get a ticket by ID.

Get a ticket by ID.

+

Request samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Get a ticket by ID.

Get a ticket by ID.

path Parameters
id
required
string

Ticket ID

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Delete a ticket.

Delete a ticket.

+

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Delete a ticket.

Delete a ticket.

path Parameters
id
required
integer

Ticket id

Responses

buckets

List all buckets.

List all buckets.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a bucket.

Create a bucket.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a bucket.

Create a bucket.

path Parameters
name
required
string

Bucket name

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "path": "string",
  • "updateUser": "string"
}

Get a bucket by ID.

Get a bucket by ID. +

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "path": "string",
  • "updateUser": "string"
}

Get a bucket by ID.

Get a bucket by ID. Returns api.Bucket when Accept=application/json. Else returns index.html when Accept=text/html. Else returns tarball.

@@ -2392,17 +2431,17 @@

Responses

businessservices

List all business services.

List all business services.

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Create a business service.

Create a business service.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Create a business service.

Create a business service.

Request Body schema: application/json

Business service data

createTime
string
createUser
string
description
string
id
integer
name
required
string
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Get a business service by ID.

Get a business service by ID.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Get a business service by ID.

Get a business service by ID.

path Parameters
id
required
string

Business Service ID

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Update a business service.

Update a business service.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Update a business service.

Update a business service.

path Parameters
id
required
string

Business service ID

Request Body schema: application/json

Business service data

createTime
string
createUser
string
description
string
id
integer
name
required
string
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Delete a business service.

Delete a business service.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Delete a business service.

Delete a business service.

path Parameters
id
required
string

Business service ID

Responses

cache

Delete a directory within the cache.

Delete a directory within the cache.

@@ -2410,12 +2449,12 @@

Get the cache.

Get the cache.

path Parameters
name
required
string

Cache DIR

Responses

Response samples

Content type
application/json
{
  • "capacity": "string",
  • "exists": true,
  • "path": "string",
  • "used": "string"
}

file

List all files.

List all files.

+

Response samples

Content type
application/json
{
  • "capacity": "string",
  • "exists": true,
  • "path": "string",
  • "used": "string"
}

file

List all files.

List all files.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a file.

Create a file.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a file.

Create a file.

path Parameters
name
required
string

File name

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "name": "string",
  • "path": "string",
  • "updateUser": "string"
}

Get a file by ID.

Get a file by ID. Returns api.File when Accept=application/json else the file content.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "name": "string",
  • "path": "string",
  • "updateUser": "string"
}

Get a file by ID.

Get a file by ID. Returns api.File when Accept=application/json else the file content.

path Parameters
id
required
string

File ID

Responses

Delete a file.

Delete a file.

@@ -2423,53 +2462,53 @@

Responses

identities

List all identities.

List all identities.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an identity.

Create an identity.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create an identity.

Create an identity.

Request Body schema: application/json

Identity data

createTime
string
createUser
string
description
string
id
integer
key
string
kind
required
string
name
required
string
password
string
settings
string
updateUser
string
user
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Get an identity by ID.

Get an identity by ID.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Get an identity by ID.

Get an identity by ID.

path Parameters
id
required
string

Identity ID

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Update an identity.

Update an identity.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Update an identity.

Update an identity.

path Parameters
id
required
string

Identity ID

Request Body schema: application/json

Identity data

createTime
string
createUser
string
description
string
id
integer
key
string
kind
required
string
name
required
string
password
string
settings
string
updateUser
string
user
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Delete an identity.

Delete an identity.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Delete an identity.

Delete an identity.

path Parameters
id
required
string

Identity ID

Responses

imports

List imports.

List imports.

Responses

Response samples

Content type
application/json
[
  • { }
]

Get an import by ID.

Get an import by ID.

+

Response samples

Content type
application/json
[
  • { }
]

Get an import by ID.

Get an import by ID.

path Parameters
id
required
string

Import ID

Responses

Response samples

Content type
application/json
{ }

Delete an import.

Delete an import. This leaves any created application or dependency.

+

Response samples

Content type
application/json
{ }

Delete an import.

Delete an import. This leaves any created application or dependency.

path Parameters
id
required
string

Import ID

Responses

List import summaries.

List import summaries.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export the source CSV for a particular import summary.

Export the source CSV for a particular import summary.

+

Response samples

Content type
application/json
[
  • {
    }
]

Export the source CSV for a particular import summary.

Export the source CSV for a particular import summary.

query Parameters
importSummary.id
required
string

ImportSummary ID

Responses

Upload a CSV containing applications and dependencies to import.

Upload a CSV containing applications and dependencies to import.

Responses

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Get an import summary by ID.

Get an import by ID.

+

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Get an import summary by ID.

Get an import by ID.

path Parameters
id
required
string

ImportSummary ID

Responses

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Delete an import summary and associated import records.

Delete an import summary and associated import records.

+

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Delete an import summary and associated import records.

Delete an import summary and associated import records.

path Parameters
id
required
string

ImportSummary ID

Responses

jobfunctions

List all job functions.

List all job functions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a job function.

Create a job function.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a job function.

Create a job function.

Request Body schema: application/json

Job Function data

createTime
string
createUser
string
id
integer
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a job function by ID.

Get a job function by ID.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a job function by ID.

Get a job function by ID.

path Parameters
id
required
string

Job Function ID

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a job function.

Update a job function.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a job function.

Update a job function.

path Parameters
id
required
string

Job Function ID

Request Body schema: application/json

Job Function data

createTime
string
createUser
string
id
integer
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a job function.

Delete a job function.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a job function.

Delete a job function.

path Parameters
id
required
string

Job Function ID

Responses

metrics

Get Prometheus metrics.

Get Prometheus metrics. @@ -2478,149 +2517,149 @@

Responses

migrationwaves

List all migration waves.

List all migration waves.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a migration wave.

Create a migration wave.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a migration wave.

Create a migration wave.

Request Body schema: application/json

Migration Wave data

Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
endDate
string
id
integer
name
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
startDate
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Get a migration wave by ID.

Get a migration wave by ID.

+

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Get a migration wave by ID.

Get a migration wave by ID.

path Parameters
id
required
integer

Migration Wave ID

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Update a migration wave.

Update a migration wave.

+

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Update a migration wave.

Update a migration wave.

path Parameters
id
required
integer

MigrationWave id

Request Body schema: application/json

MigrationWave data

Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
endDate
string
id
integer
name
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
startDate
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Delete a migration wave.

Delete a migration wave.

+

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Delete a migration wave.

Delete a migration wave.

path Parameters
id
required
integer

MigrationWave id

Responses

proxies

List all proxies.

List all proxies.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an proxy.

Create an proxy.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create an proxy.

Create an proxy.

Request Body schema: application/json

Proxy data

createTime
string
createUser
string
enabled
boolean
excluded
Array of strings
host
string
id
integer
object (api.Ref)
kind
string
Enum: "http" "https"
port
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Get an proxy by ID.

Get an proxy by ID.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Get an proxy by ID.

Get an proxy by ID.

path Parameters
id
required
string

Proxy ID

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Update an proxy.

Update an proxy.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Update an proxy.

Update an proxy.

path Parameters
id
required
string

Proxy ID

Request Body schema: application/json

Proxy data

createTime
string
createUser
string
enabled
boolean
excluded
Array of strings
host
string
id
integer
object (api.Ref)
kind
string
Enum: "http" "https"
port
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Delete an proxy.

Delete an proxy.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Delete an proxy.

Delete an proxy.

path Parameters
id
required
string

Proxy ID

Responses

reviews

List all reviews.

List all reviews.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a review.

Create a review.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a review.

Create a review.

Request Body schema: application/json

Review data

required
object (api.Ref)
businessCriticality
integer
comments
string
createTime
string
createUser
string
effortEstimate
string
id
integer
proposedAction
string
updateUser
string
workPriority
integer

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Copy a review from one application to others.

Copy a review from one application to others.

+

Request samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Copy a review from one application to others.

Copy a review from one application to others.

Request Body schema: application/json

Review copy request data

sourceReview
required
integer
targetApplications
required
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "sourceReview": 0,
  • "targetApplications": [
    ]
}

Get a review by ID.

Get a review by ID.

+

Request samples

Content type
application/json
{
  • "sourceReview": 0,
  • "targetApplications": [
    ]
}

Get a review by ID.

Get a review by ID.

path Parameters
id
required
string

Review ID

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Update a review.

Update a review.

+

Response samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Update a review.

Update a review.

path Parameters
id
required
string

Review ID

Request Body schema: application/json

Review data

required
object (api.Ref)
businessCriticality
integer
comments
string
createTime
string
createUser
string
effortEstimate
string
id
integer
proposedAction
string
updateUser
string
workPriority
integer

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Delete a review.

Delete a review.

+

Request samples

Content type
application/json
{
  • "application": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Delete a review.

Delete a review.

path Parameters
id
required
string

Review ID

Responses

rulesets

List all bindings.

List all bindings.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ruleset.

Create a ruleset.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a ruleset.

Create a ruleset.

Request Body schema: application/json

RuleSet data

createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Get a RuleSet by ID.

Get a RuleSet by ID.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Get a RuleSet by ID.

Get a RuleSet by ID.

path Parameters
id
required
string

RuleSet ID

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Update a ruleset.

Update a ruleset.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Update a ruleset.

Update a ruleset.

path Parameters
id
required
string

RuleSet ID

Request Body schema: application/json

RuleSet data

createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Delete a ruleset.

Delete a ruleset.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "image": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Delete a ruleset.

Delete a ruleset.

path Parameters
id
required
string

RuleSet ID

Responses

schema

Get the API schema.

Get the API schema.

Responses

Response samples

Content type
application/json
{
  • "paths": [
    ],
  • "version": "string"
}

settings

List all settings.

List all settings.

+

Response samples

Content type
application/json
{
  • "paths": [
    ],
  • "version": "string"
}

settings

List all settings.

List all settings.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a setting.

Create a setting.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a setting.

Create a setting.

Request Body schema: application/json

Setting data

key
string
value
any

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Get a setting by its key.

Get a setting by its key.

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Get a setting by its key.

Get a setting by its key.

path Parameters
key
required
string

Key

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Update a setting.

Update a setting.

+

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Update a setting.

Update a setting.

path Parameters
key
required
string

Key

Responses

Create a setting.

Create a setting.

Request Body schema: application/json

Setting value

key
string
value
any

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Delete a setting.

Delete a setting.

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": null
}

Delete a setting.

Delete a setting.

path Parameters
key
required
string

Key

Responses

stakeholdergroups

List all stakeholder groups.

List all stakeholder groups.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder group.

Create a stakeholder group.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder group.

Create a stakeholder group.

Request Body schema: application/json

Stakeholder Group data

createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a stakeholder group by ID.

Get a stakeholder group by ID.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a stakeholder group by ID.

Get a stakeholder group by ID.

path Parameters
id
required
string

Stakeholder Group ID

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a stakeholder group.

Update a stakeholder group.

+

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a stakeholder group.

Update a stakeholder group.

path Parameters
id
required
string

Stakeholder Group ID

Request Body schema: application/json

Stakeholder Group data

createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder group.

Delete a stakeholder group.

+

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder group.

Delete a stakeholder group.

path Parameters
id
required
string

Stakeholder Group ID

Responses

stakeholders

List all stakeholders.

List all stakeholders.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder.

Create a stakeholder.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder.

Create a stakeholder.

Request Body schema: application/json

Stakeholder data

Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Get a stakeholder by ID.

Get a stakeholder by ID.

+

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Get a stakeholder by ID.

Get a stakeholder by ID.

path Parameters
id
required
string

Stakeholder ID

Responses

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Update a stakeholder.

Update a stakeholder.

+

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Update a stakeholder.

Update a stakeholder.

path Parameters
id
required
string

Stakeholder ID

Request Body schema: application/json

Stakeholder data

Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder.

Delete a stakeholder.

+

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder.

Delete a stakeholder.

path Parameters
id
required
string

Stakeholder ID

Responses

tagcategories

List all tag categories.

List all tag categories.

query Parameters
name
string

Optional category name filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag category.

Create a tag category.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag category.

Create a tag category.

Request Body schema: application/json

Tag Category data

colour
string
createTime
string
createUser
string
id
integer
name
required
string
rank
integer
Array of objects (api.Ref) [ items ]
updateUser
string
username
string

Responses

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Get a tag category by ID.

Get a tag category by ID.

+

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Get a tag category by ID.

Get a tag category by ID.

path Parameters
id
required
string

Tag Category ID

Responses

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Update a tag category.

Update a tag category.

+

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Update a tag category.

Update a tag category.

path Parameters
id
required
string

Tag Category ID

Request Body schema: application/json

Tag Category data

colour
string
createTime
string
createUser
string
id
integer
name
required
string
rank
integer
Array of objects (api.Ref) [ items ]
updateUser
string
username
string

Responses

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Delete a tag category.

Delete a tag category.

+

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Delete a tag category.

Delete a tag category.

path Parameters
id
required
string

Tag Category ID

Responses

List the tags in the tag category.

List the tags in the tag category.

path Parameters
id
required
string

Tag Category ID

query Parameters
name
string

Optional tag name filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

taskgroups

List all task groups.

List all task groups.

+

Response samples

Content type
application/json
[
  • {
    }
]

taskgroups

List all task groups.

List all task groups.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task group.

Create a task group.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a task group.

Create a task group.

Request Body schema: application/json

TaskGroup data

addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
id
integer
name
string
state
string
Array of objects (api.Task) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Get a task group by ID.

Get a task group by ID.

+

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Get a task group by ID.

Get a task group by ID.

path Parameters
id
required
string

TaskGroup ID

Responses

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Update a task group.

Update a task group.

+

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Update a task group.

Update a task group.

path Parameters
id
required
string

Task ID

Request Body schema: application/json

Task data

addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
id
integer
name
string
state
string
Array of objects (api.Task) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Delete a task group.

Delete a task group.

+

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Delete a task group.

Delete a task group.

path Parameters
id
required
string

TaskGroup ID

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. @@ -2639,19 +2678,19 @@

path Parameters
id
required
string

TaskGroup ID

Request Body schema: application/json

TaskGroup data (optional)

addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
id
integer
name
string
state
string
Array of objects (api.Task) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

tasks

List all tasks.

List all tasks.

+

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

tasks

List all tasks.

List all tasks.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task.

Create a task.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a task.

Create a task.

Request Body schema: application/json

Task data

addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
error
string
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
object (api.TaskReport)
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Response samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Get a task by ID.

Get a task by ID.

+

Request samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Response samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Get a task by ID.

Get a task by ID.

path Parameters
id
required
string

Task ID

Responses

Response samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Update a task.

Update a task.

+

Response samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Update a task.

Update a task.

path Parameters
id
required
string

Task ID

Request Body schema: application/json

Task data

addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
error
string
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
object (api.TaskReport)
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Delete a task.

Delete a task.

+

Request samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Delete a task.

Delete a task.

path Parameters
id
required
string

Task ID

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. @@ -2673,35 +2712,35 @@

path Parameters
id
required
string

Task ID

Request Body schema: application/json

TaskReport data

activity
Array of strings
completed
integer
createTime
string
createUser
string
error
string
id
integer
result
object
status
string
task
integer
total
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Create a task report.

Update a task report.

+

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Create a task report.

Update a task report.

path Parameters
id
required
string

Task ID

Request Body schema: application/json

TaskReport data

activity
Array of strings
completed
integer
createTime
string
createUser
string
error
string
id
integer
result
object
status
string
task
integer
total
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Delete a task report.

Delete a task report.

+

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "error": "string",
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Delete a task report.

Delete a task report.

path Parameters
id
required
string

Task ID

Responses

Submit a task.

Submit a task.

path Parameters
id
required
string

Task ID

Request Body schema: application/json

Task data (optional)

addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
error
string
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
object (api.TaskReport)
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

trackers

List all trackers.

List all trackers.

+

Request samples

Content type
application/json
{
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "error": "string",
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "report": {
    },
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

trackers

List all trackers.

List all trackers.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tracker.

Create a tracker.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a tracker.

Create a tracker.

Request Body schema: application/json

Tracker data

-
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-server" "jira-datacenter"
lastUpdated
string
message
string
object (api.Metadata)
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Get a tracker by ID.

Get a tracker by ID.

+
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-onprem"
lastUpdated
string
message
string
object (api.Metadata)
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Get a tracker by ID.

Get a tracker by ID.

path Parameters
id
required
string

Tracker ID

Responses

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Update a tracker.

Update a tracker.

+

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Update a tracker.

Update a tracker.

path Parameters
id
required
integer

Tracker id

Request Body schema: application/json

Tracker data

-
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-server" "jira-datacenter"
lastUpdated
string
message
string
object (api.Metadata)
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Delete a tracker.

Delete a tracker.

+
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-onprem"
lastUpdated
string
message
string
object (api.Metadata)
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "metadata": { },
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Delete a tracker.

Delete a tracker.

path Parameters
id
required
integer

Tracker id

Responses