From 789865e4c8f6b7511dc081ad71843b54dd987e53 Mon Sep 17 00:00:00 2001 From: Jeff Ortel Date: Wed, 15 Nov 2023 07:15:04 -0800 Subject: [PATCH 1/3] DepReport aggregated by name. Signed-off-by: Jeff Ortel --- api/analysis.go | 36 ++++++++++++++++++------------------ hack/add/analysis.sh | 12 ++++++++++-- 2 files changed, 28 insertions(+), 20 deletions(-) diff --git a/api/analysis.go b/api/analysis.go index aa1529d8a..377733154 100644 --- a/api/analysis.go +++ b/api/analysis.go @@ -1364,8 +1364,7 @@ func (h AnalysisHandler) Deps(ctx *gin.Context) { // @description sort: // @description - provider // @description - name -// @description - version -// @description - sha +// @description - labels // @tags dependencies // @produce json // @success 200 {object} []api.TechDependency @@ -1406,16 +1405,15 @@ func (h AnalysisHandler) DepReports(ctx *gin.Context) { // Inner Query q := h.DB(ctx) q = q.Select( - "Provider", - "Name", - "Version", - "SHA", - "Labels", - "COUNT(distinct AnalysisID) Applications") - q = q.Model(&model.TechDependency{}) - q = q.Where("AnalysisID IN (?)", h.analysisIDs(ctx, filter)) - q = q.Where("ID IN (?)", h.depIDs(ctx, filter)) - q = q.Group("Name,SHA") + "d.Provider", + "d.Name", + "json_group_array(distinct j.value) Labels", + "COUNT(distinct d.AnalysisID) Applications") + q = q.Table("TechDependency d") + q = q.Joins(",json_each(Labels) j") + q = q.Where("d.AnalysisID IN (?)", h.analysisIDs(ctx, filter)) + q = q.Where("d.ID IN (?)", h.depIDs(ctx, filter)) + q = q.Group("d.Provider, d.Name") // Find db := h.DB(ctx) db = db.Select("*") @@ -1448,12 +1446,16 @@ func (h AnalysisHandler) DepReports(ctx *gin.Context) { r := DepReport{ Provider: m.Provider, Name: m.Name, - Version: m.Version, - SHA: m.SHA, Applications: m.Applications, } if m.Labels != nil { - _ = json.Unmarshal(m.Labels, &r.Labels) + var aggregated []string + _ = json.Unmarshal(m.Labels, &aggregated) + for _, s := range aggregated { + if s != "" { + r.Labels = append(r.Labels, s) + } + } } resources = append(resources, r) } @@ -2083,8 +2085,6 @@ type FileReport struct { type DepReport struct { Provider string `json:"provider"` Name string `json:"name"` - Version string `json:"version"` - SHA string `json:"sha"` Labels []string `json:"labels"` Applications int `json:"applications"` } @@ -2101,7 +2101,7 @@ type DepAppReport struct { Provider string `json:"provider"` Name string `json:"name"` Version string `json:"version"` - SHA string `json:"rule"` + SHA string `json:"sha"` Indirect bool `json:"indirect"` Labels []string `json:"labels"` } `json:"dependency"` diff --git a/hack/add/analysis.sh b/hack/add/analysis.sh index c1fa159f4..15bfb58c2 100755 --- a/hack/add/analysis.sh +++ b/hack/add/analysis.sh @@ -156,11 +156,19 @@ done file=${dPath} echo -n "--- name: github.com/jboss -version: 5.0 +version: 4.0 labels: -- konveyor.io/dep-source +- konveyor.io/language=java +- konveyor.io/otherA=dog " > ${file} echo -n "--- +name: github.com/jboss +version: 5.0 +labels: +- konveyor.io/language=java +- konveyor.io/otherA=cat +" >> ${file} +echo -n "--- name: github.com/hybernate indirect: "true" version: 4.6 From 5ca66639a39d32eb5f335c7c6654063369c3b4f3 Mon Sep 17 00:00:00 2001 From: Jeff Ortel Date: Wed, 15 Nov 2023 09:10:47 -0800 Subject: [PATCH 2/3] sort dep labels. Signed-off-by: Jeff Ortel --- api/analysis.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api/analysis.go b/api/analysis.go index 377733154..b003cd707 100644 --- a/api/analysis.go +++ b/api/analysis.go @@ -16,6 +16,7 @@ import ( "io" "net/http" "os" + "sort" "strconv" "strings" ) @@ -1966,6 +1967,7 @@ func (r *TechDependency) With(m *model.TechDependency) { // // Model builds a model. func (r *TechDependency) Model() (m *model.TechDependency) { + sort.Strings(r.Labels) m = &model.TechDependency{} m.Name = r.Name m.Version = r.Version From 35d876edc75bed31428db4036af82d300698952f Mon Sep 17 00:00:00 2001 From: Jeff Ortel Date: Wed, 15 Nov 2023 12:40:26 -0800 Subject: [PATCH 3/3] Regenerated docs. Signed-off-by: Jeff Ortel --- docs/docs.go | 9 +- docs/index.html | 2777 +++++++++++++++++++++++--------------------- docs/openapi3.json | 16 +- docs/swagger.json | 4 +- docs/swagger.yaml | 5 +- 5 files changed, 1445 insertions(+), 1366 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index 63e0ce976..2318e3e2f 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1,4 +1,5 @@ -// Package docs Code generated by swaggo/swag. DO NOT EDIT +// Package docs GENERATED BY SWAG; DO NOT EDIT +// This file was generated by swaggo/swag package docs import "github.com/swaggo/swag" @@ -139,7 +140,7 @@ const docTemplate = `{ }, "/analyses/dependencies": { "get": { - "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- version\n- sha", + "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- labels", "produces": [ "application/json" ], @@ -5849,7 +5850,7 @@ const docTemplate = `{ "provider": { "type": "string" }, - "rule": { + "sha": { "type": "string" }, "version": { @@ -7429,8 +7430,6 @@ var SwaggerInfo = &swag.Spec{ Description: "", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, - LeftDelim: "{{", - RightDelim: "}}", } func init() { diff --git a/docs/index.html b/docs/index.html index d63749231..bc2ec2a24 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,21 +13,27 @@ } -

Konveyor Hub API (0.3.z)

Download OpenAPI specification:Download

License: Apache 2.0

addons

List all addons.

List all addons.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an addon by name.

Get an addon by name.

-
path Parameters
name
required
string

Addon name

-

Responses

Response samples

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

adoptionplans

Generate an application dependency graph arranged in topological order.

Graph generates an application dependency graph arranged in topological order.

-
Request Body schema: application/json

List of requested App IDs

-
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
[
  • {
    }
]

analyses

List analyses.

List analyses for an application. + " fill="currentColor">

Konveyor Hub API (0.3.z)

Download OpenAPI specification:Download

License: Apache 2.0

addons

List all addons.

List all addons.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an addon by name.

Get an addon by name.

+
path Parameters
name
required
string

Addon name

+

Responses

Response samples

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

adoptionplans

Generate an application dependency graph arranged in topological order.

Graph generates an application dependency graph arranged in topological order.

+
Request Body schema: application/json

List of requested App IDs

+
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
[
  • {
    }
]

analyses

List analyses.

List analyses for an application. Resources do not include relations.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an analysis (report) by ID.

Get an analysis (report) by ID.

-
path Parameters
id
required
integer

Analysis ID

-

Responses

Delete an analysis by ID.

Delete an analysis by ID.

-
path Parameters
id
required
integer

Analysis ID

-

Responses

Create an analysis.

Create an analysis. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an analysis (report) by ID.

Get an analysis (report) by ID.

+
path Parameters
id
required
integer

Analysis ID

+

Responses

Delete an analysis by ID.

Delete an analysis by ID.

+
path Parameters
id
required
integer

Analysis ID

+

Responses

Create an analysis.

Create an analysis. Form fields:

  • file: file that contains the api.Analysis resource.
  • issues: file that multiple api.Issue resources.
  • dependencies: file that multiple api.TechDependency resources.
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
{
  • "archived": true,
  • "createTime": "string",
  • "createUser": "string",
  • "dependencies": [
    ],
  • "effort": 0,
  • "id": 0,
  • "issues": [
    ],
  • "summary": { },
  • "updateUser": "string"
}

Get the latest analysis.

Get the latest analysis for an application.

-
path Parameters
id
required
integer

Application ID

-

Responses

Get the latest analysis (static) report.

Get the latest analysis (static) report.

-
path Parameters
id
required
integer

Application ID

-

Responses

dependencies

List dependency reports.

Each report collates dependencies by name and SHA. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
{
  • "archived": true,
  • "createTime": "string",
  • "createUser": "string",
  • "dependencies": [
    ],
  • "effort": 0,
  • "id": 0,
  • "issues": [
    ],
  • "summary": { },
  • "updateUser": "string"
}

Get the latest analysis.

Get the latest analysis for an application.

+
path Parameters
id
required
integer

Application ID

+

Responses

Get the latest analysis (static) report.

Get the latest analysis (static) report.

+
path Parameters
id
required
integer

Application ID

+

Responses

dependencies

List dependency reports.

Each report collates dependencies by name and SHA. filters:

  • provider
  • @@ -2166,11 +2244,10 @@ sort:
  • provider
  • name
  • -
  • version
  • -
  • sha
  • +
  • labels
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application dependencies.

List application dependencies. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application dependencies.

List application dependencies. filters:

  • name
  • @@ -2179,20 +2256,20 @@
  • indirect
  • labels
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all dependencies.

List all dependencies.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a dependency.

Create a dependency.

-
Request Body schema: application/json

Dependency data

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

Responses

Request samples

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

Response samples

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

Get a dependency by ID.

Get a dependency by ID.

-
path Parameters
id
required
integer

Dependency ID

-

Responses

Response samples

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

Delete a dependency.

Delete a dependency.

-
path Parameters
id
required
integer

Dependency id

-

Responses

issues

List all issues.

List all issues. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all dependencies.

List all dependencies.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a dependency.

Create a dependency.

+
Request Body schema: application/json

Dependency data

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

Responses

Request samples

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

Response samples

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

Get a dependency by ID.

Get a dependency by ID.

+
path Parameters
id
required
integer

Dependency ID

+

Responses

Response samples

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

Delete a dependency.

Delete a dependency.

+
path Parameters
id
required
integer

Dependency id

+

Responses

issues

List all issues.

List all issues. filters:

  • ruleset
  • @@ -2205,8 +2282,8 @@
  • application.name
  • tag.id
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application issues.

List application issues. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application issues.

List application issues. filters:

  • ruleset
  • @@ -2216,19 +2293,19 @@
  • effort
  • labels
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issue

Get an issue.

Get an issue.

-
path Parameters
id
required
integer

Issue ID

-

Responses

Response samples

Content type
application/json
{
  • "category": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "facts": { },
  • "id": 0,
  • "incidents": [
    ],
  • "labels": [
    ],
  • "links": [
    ],
  • "name": "string",
  • "rule": "string",
  • "ruleset": "string",
  • "updateUser": "string"
}

incidents

List incidents for an issue.

List incidents for an issue. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issue

Get an issue.

Get an issue.

+
path Parameters
id
required
integer

Issue ID

+

Responses

Response samples

Content type
application/json
{
  • "category": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "facts": { },
  • "id": 0,
  • "incidents": [
    ],
  • "labels": [
    ],
  • "links": [
    ],
  • "name": "string",
  • "rule": "string",
  • "ruleset": "string",
  • "updateUser": "string"
}

incidents

List incidents for an issue.

List incidents for an issue. filters:

  • file
-
path Parameters
id
required
integer

Issue ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

depappreports

List application reports.

List application reports. +

path Parameters
id
required
integer

Issue ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

depappreports

List application reports.

List application reports. filters:

  • id
  • @@ -2260,8 +2337,8 @@
  • sha
  • indirect
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issuereport

List application issue reports.

Each report collates issues by ruleset/rule. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issuereport

List application issue reports.

Each report collates issues by ruleset/rule. filters:

  • ruleset
  • @@ -2276,9 +2353,9 @@
  • effort
  • files
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

filereports

List incident file reports.

Each report collates incidents by file. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

filereports

List incident file reports.

Each report collates incidents by file. filters:

  • file
  • @@ -2289,9 +2366,9 @@
  • effort
  • incidents
-
path Parameters
id
required
integer

Issue ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

rulereports

List rule reports.

Each report collates issues by ruleset/rule. +

path Parameters
id
required
integer

Issue ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

rulereports

List rule reports.

Each report collates issues by ruleset/rule. filters:

  • ruleset
  • @@ -2312,575 +2389,575 @@
  • effort
  • applications
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

applications

List all applications.

List all applications.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application.

Create an application.

-
Request Body schema: application/json

Application data

-
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref) [ items ]
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete a applications.

Delete applications.

-
Request Body schema: application/json

List of id

-
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Get an application by ID.

Get an application by ID.

-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an application.

Update an application.

-
path Parameters
id
required
integer

Application id

-
Request Body schema: application/json

Application data

-
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref) [ items ]
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an application.

Delete an application.

-
path Parameters
id
required
integer

Application id

-

Responses

List the assessments of an Application and any it inherits from its archetypes.

List the assessments of an Application and any it inherits from its archetypes.

-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application assessment.

Create an application assessment.

-
path Parameters
id
required
integer

Application ID

-
Request Body schema: application/json

Assessment data

-
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

-
object (assessment.RiskMessages)
Array of objects (assessment.Section) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get bucket content by ID and path.

Get bucket content by ID and path. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

applications

List all applications.

List all applications.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application.

Create an application.

+
Request Body schema: application/json

Application data

+
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref)
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref)
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete a applications.

Delete applications.

+
Request Body schema: application/json

List of id

+
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Get an application by ID.

Get an application by ID.

+
path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an application.

Update an application.

+
path Parameters
id
required
integer

Application id

+
Request Body schema: application/json

Application data

+
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref)
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref)
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an application.

Delete an application.

+
path Parameters
id
required
integer

Application id

+

Responses

List the assessments of an Application and any it inherits from its archetypes.

List the assessments of an Application and any it inherits from its archetypes.

+
path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application assessment.

Create an application assessment.

+
path Parameters
id
required
integer

Application ID

+
Request Body schema: application/json

Assessment data

+
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

+
object (assessment.RiskMessages)
Array of objects (assessment.Section)
Array of objects (api.Ref)
Array of objects (api.Ref)
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get bucket content by ID and path.

Get bucket content by ID and path. Returns index.html for directories when Accept=text/html else a tarball. ?filter=glob supports directory content filtering.

-
path Parameters
id
required
integer

Application ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

Application ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Application ID

-
wildcard
required
string

Content path

-

Responses

Create a fact.

Create a fact.

-
path Parameters
id
required
integer

Application ID

-
Request Body schema: application/json

Fact data

-
key
string
source
string
value
object

Responses

Request samples

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

Get fact by name.

Get fact by name. +

path Parameters
id
required
integer

Application ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

Application ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Application ID

+
wildcard
required
string

Content path

+

Responses

Create a fact.

Create a fact.

+
path Parameters
id
required
integer

Application ID

+
Request Body schema: application/json

Fact data

+
key
string
source
string
value
object

Responses

Request samples

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

Get fact by name.

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

-
path Parameters
id
required
integer

Application ID

-
key
required
string

Fact key

-

Responses

Response samples

Content type
application/json
{ }

Update (or create) a fact.

Update (or create) a fact. +

path Parameters
id
required
integer

Application ID

+
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
integer

Application ID

-
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. +

path Parameters
id
required
integer

Application ID

+
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
integer

Application ID

-
key
required
string

Fact key

-

Responses

List facts.

List facts by source. +

path Parameters
id
required
integer

Application ID

+
key
required
string

Fact key

+

Responses

List facts.

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

-
path Parameters
id
required
integer

Application ID

-
source
required
string

Source key

-

Responses

Response samples

Content type
application/json
{ }

Replace all facts from a source.

Replace all facts from a source. +

path Parameters
id
required
integer

Application ID

+
source
required
string

Source key

+

Responses

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
integer

Application ID

-
source
required
string

Fact key

-
Request Body schema: application/json

Fact map

-
object (api.FactMap)

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": {
    }
}

List tag references.

List tag references.

-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add tag association.

Ensure tag is associated with the application.

-
path Parameters
id
required
integer

Application ID

-
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.

-
path Parameters
id
required
integer

Application ID

-
query Parameters
source
string

Source

-
Request Body schema: application/json

Tag references

-
Array
id
required
integer
name
string
source
string
virtual
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete tag association.

Ensure tag is not associated with the application.

-
path Parameters
id
required
integer

Application ID

-
sid
required
string

Tag ID

-

Responses

archetypes

List all archetypes.

List all archetypes.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype.

Create an archetype.

-
Request Body schema: application/json

Archetype data

-
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef) [ items ]
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Get an archetype by ID.

Get an archetype by ID.

-
path Parameters
id
required
integer

Archetype ID

-

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an archetype.

Update an archetype.

-
path Parameters
id
required
integer

Archetype ID

-
Request Body schema: application/json

Archetype data

-
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef) [ items ]
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an archetype.

Delete an archetype.

-
path Parameters
id
required
integer

Archetype ID

-

Responses

List the assessments of an archetype.

List the assessments of an archetype.

-
path Parameters
id
required
integer

Archetype ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype assessment.

Create an archetype assessment.

-
path Parameters
id
required
integer

Archetype ID

-
Request Body schema: application/json

Assessment data

-
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

-
object (assessment.RiskMessages)
Array of objects (assessment.Section) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

assessments

List all assessments.

List all assessments.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an assessment.

Update an assessment.

-
path Parameters
id
required
integer

Assessment ID

-
Request Body schema: application/json

Assessment data

-
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

-
object (assessment.RiskMessages)
Array of objects (assessment.Section) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete an assessment.

Delete an assessment.

-
path Parameters
id
required
integer

Assessment ID

-

Responses

questionnaires

Get an assessment by ID.

Get an assessment by ID.

-
path Parameters
id
required
integer

Assessment ID

-

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

List all questionnaires.

List all questionnaires.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a questionnaire.

Create a questionnaire.

-
Request Body schema: application/json

Questionnaire data

-
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section) [ items ]
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get a questionnaire by ID.

Get a questionnaire by ID.

-
path Parameters
id
required
integer

Questionnaire ID

-

Responses

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Update a questionnaire.

Update a questionnaire. If the Questionnaire +

path Parameters
id
required
integer

Application ID

+
source
required
string

Fact key

+
Request Body schema: application/json

Fact map

+
property name*
additional property
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)
object (api.Ref)

Responses

Request samples

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

List tag references.

List tag references.

+
path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add tag association.

Ensure tag is associated with the application.

+
path Parameters
id
required
integer

Application ID

+
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.

+
path Parameters
id
required
integer

Application ID

+
query Parameters
source
string

Source

+
Request Body schema: application/json

Tag references

+
Array
id
required
integer
name
string
source
string
virtual
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete tag association.

Ensure tag is not associated with the application.

+
path Parameters
id
required
integer

Application ID

+
sid
required
string

Tag ID

+

Responses

archetypes

List all archetypes.

List all archetypes.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype.

Create an archetype.

+
Request Body schema: application/json

Archetype data

+
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef)
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref)
Array of objects (api.Ref)
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Get an archetype by ID.

Get an archetype by ID.

+
path Parameters
id
required
integer

Archetype ID

+

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an archetype.

Update an archetype.

+
path Parameters
id
required
integer

Archetype ID

+
Request Body schema: application/json

Archetype data

+
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef)
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref)
Array of objects (api.Ref)
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an archetype.

Delete an archetype.

+
path Parameters
id
required
integer

Archetype ID

+

Responses

List the assessments of an archetype.

List the assessments of an archetype.

+
path Parameters
id
required
integer

Archetype ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype assessment.

Create an archetype assessment.

+
path Parameters
id
required
integer

Archetype ID

+
Request Body schema: application/json

Assessment data

+
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

+
object (assessment.RiskMessages)
Array of objects (assessment.Section)
Array of objects (api.Ref)
Array of objects (api.Ref)
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

assessments

List all assessments.

List all assessments.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an assessment.

Update an assessment.

+
path Parameters
id
required
integer

Assessment ID

+
Request Body schema: application/json

Assessment data

+
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

+
object (assessment.RiskMessages)
Array of objects (assessment.Section)
Array of objects (api.Ref)
Array of objects (api.Ref)
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete an assessment.

Delete an assessment.

+
path Parameters
id
required
integer

Assessment ID

+

Responses

questionnaires

Get an assessment by ID.

Get an assessment by ID.

+
path Parameters
id
required
integer

Assessment ID

+

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

List all questionnaires.

List all questionnaires.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a questionnaire.

Create a questionnaire.

+
Request Body schema: application/json

Questionnaire data

+
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section)
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get a questionnaire by ID.

Get a questionnaire by ID.

+
path Parameters
id
required
integer

Questionnaire ID

+

Responses

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Update a questionnaire.

Update a questionnaire. If the Questionnaire is builtin, only its "required" field can be changed and all other fields will be ignored.

-
path Parameters
id
required
integer

Questionnaire ID

-
Request Body schema: application/json

Questionnaire data

-
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section) [ items ]
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete a questionnaire.

Delete a questionnaire.

-
path Parameters
id
required
integer

Questionnaire 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.

-

Responses

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 Body schema: application/json

Tickets data

-
Array
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
fields
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 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.

-

Responses

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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
fields
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.

-

Responses

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
fields
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.

-
path Parameters
id
required
integer

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.

-
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.

-
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. +

path Parameters
id
required
integer

Questionnaire ID

+
Request Body schema: application/json

Questionnaire data

+
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section)
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete a questionnaire.

Delete a questionnaire.

+
path Parameters
id
required
integer

Questionnaire 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.

+

Responses

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 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 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.

+

Responses

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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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.

+

Responses

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.

+
path Parameters
id
required
integer

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.

+
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.

+
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. Returns api.Bucket when Accept=application/json. Else returns index.html when Accept=text/html. Else returns tarball.

-
path Parameters
id
required
integer

Bucket ID

-

Responses

Delete a bucket.

Delete a bucket.

-
path Parameters
id
required
integer

Bucket ID

-

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. +

path Parameters
id
required
integer

Bucket ID

+

Responses

Delete a bucket.

Delete a bucket.

+
path Parameters
id
required
integer

Bucket ID

+

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. When path is FILE, returns file content. When path is DIRECTORY and Accept=text/html returns index.html. ?filter=glob supports directory content filtering. Else returns a tarball.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

Bucket ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Bucket ID

-
wildcard
required
string

Content path

-

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.

-
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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

Business service ID

-

Responses

cache

Delete a directory within the cache.

Delete a directory within the cache.

-

Responses

Get the cache.

Get the cache.

-
path Parameters
wildcard
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.

-

Responses

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.

-
path Parameters
id
required
integer

File ID

-

Responses

Delete a file.

Delete a file.

-
path Parameters
id
required
integer

File ID

-

Responses

identities

List all identities.

List all identities.

-

Responses

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

Import ID

-

Responses

Response samples

Content type
application/json
{ }

Delete an import.

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

-
path Parameters
id
required
integer

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.

-
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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

Job Function ID

-

Responses

metrics

Get Prometheus metrics.

Get Prometheus metrics. +

path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

Bucket ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Bucket ID

+
wildcard
required
string

Content path

+

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.

+
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

Business service ID

+

Responses

cache

Delete a directory within the cache.

Delete a directory within the cache.

+

Responses

Get the cache.

Get the cache.

+
path Parameters
wildcard
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.

+

Responses

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.

+
path Parameters
id
required
integer

File ID

+

Responses

Delete a file.

Delete a file.

+
path Parameters
id
required
integer

File ID

+

Responses

identities

List all identities.

List all identities.

+

Responses

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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

Import ID

+

Responses

Response samples

Content type
application/json
{ }

Delete an import.

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

+
path Parameters
id
required
integer

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.

+
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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.

+
Request Body schema: application/json

Job Function data

+
createTime
string
createUser
string
id
integer
name
required
string
Array of objects (api.Ref)
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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)
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.

+
path Parameters
id
required
integer

Job Function ID

+

Responses

metrics

Get Prometheus metrics.

Get Prometheus metrics. Wrapper for Prometheus-supplied handler. Served on port defined by METRICS_PORT environment variable.

-

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.

-
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.

-
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.

-
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.

-
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.

-
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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

Proxy ID

-

Responses

reviews

List all reviews.

List all reviews.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a review.

Create a review.

-
Request Body schema: application/json

Review data

-
object (api.Ref)
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": {
    },
  • "archetype": {
    },
  • "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": {
    },
  • "archetype": {
    },
  • "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.

-
path Parameters
id
required
integer

Review ID

-

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "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
integer

Review ID

-
Request Body schema: application/json

Review data

-
object (api.Ref)
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": {
    },
  • "archetype": {
    },
  • "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
integer

Review ID

-

Responses

rulesets

List all bindings.

List all bindings. +

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.

+
Request Body schema: application/json

Migration Wave data

+
Array of objects (api.Ref)
createTime
string
createUser
string
endDate
string
id
integer
name
string
Array of objects (api.Ref)
Array of objects (api.Ref)
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.

+
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.

+
path Parameters
id
required
integer

MigrationWave id

+
Request Body schema: application/json

MigrationWave data

+
Array of objects (api.Ref)
createTime
string
createUser
string
endDate
string
id
integer
name
string
Array of objects (api.Ref)
Array of objects (api.Ref)
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.

+
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.

+
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

Proxy ID

+

Responses

reviews

List all reviews.

List all reviews.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a review.

Create a review.

+
Request Body schema: application/json

Review data

+
object (api.Ref)
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": {
    },
  • "archetype": {
    },
  • "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": {
    },
  • "archetype": {
    },
  • "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

Responses

Request samples

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

Get a review by ID.

Get a review by ID.

+
path Parameters
id
required
integer

Review ID

+

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "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
integer

Review ID

+
Request Body schema: application/json

Review data

+
object (api.Ref)
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": {
    },
  • "archetype": {
    },
  • "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
integer

Review ID

+

Responses

rulesets

List all bindings.

List all bindings. filters:

  • name
  • labels
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ruleset.

Create a ruleset.

-
Request Body schema: application/json

RuleSet data

-
createTime
string
createUser
string
Array of objects (api.Ref) [ items ]
description
string
id
integer
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",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Response samples

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

Get a RuleSet by ID.

Get a RuleSet by ID.

-
path Parameters
id
required
integer

RuleSet ID

-

Responses

Response samples

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

Update a ruleset.

Update a ruleset.

-
path Parameters
id
required
integer

RuleSet ID

-
Request Body schema: application/json

RuleSet data

-
createTime
string
createUser
string
Array of objects (api.Ref) [ items ]
description
string
id
integer
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",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Delete a ruleset.

Delete a ruleset.

-
path Parameters
id
required
integer

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.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a setting.

Create a setting.

-
Request Body schema: application/json

Setting data

-
key
string
value
object

Responses

Request samples

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

Response samples

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

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": { }
}

Update a setting.

Update a setting.

-
path Parameters
key
required
string

Key

-

Responses

Create a setting.

Create a setting.

-
path Parameters
key
required
string

Key

-
Request Body schema: application/json

Setting value

-
key
string
value
object

Responses

Request samples

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

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.

-
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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

Stakeholder Group ID

-

Responses

stakeholders

List all stakeholders.

List all stakeholders.

-

Responses

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

Tag Category ID

-

Responses

List the tags in the tag category.

List the tags in the tag category.

-
path Parameters
id
required
integer

Tag Category ID

-
query Parameters
name
string

Optional tag name filter

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

targets

List all targets.

List all targets.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a target.

Create a target.

-
Request Body schema: application/json

Target data

-
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label) [ items ]
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Get a Target by ID.

Get a Target by ID.

-
path Parameters
id
required
integer

Target ID

-

Responses

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Update a target.

Update a target.

-
path Parameters
id
required
integer

Target ID

-
Request Body schema: application/json

Target data

-
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label) [ items ]
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Delete a target.

Delete a target.

-
path Parameters
id
required
integer

Target ID

-

Responses

taskgroups

List all task groups.

List all task groups.

-

Responses

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

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.

-
path Parameters
id
required
integer

TaskGroup ID

-

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ruleset.

Create a ruleset.

+
Request Body schema: application/json

RuleSet data

+
createTime
string
createUser
string
Array of objects (api.Ref)
description
string
id
integer
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule)
updateUser
string

Responses

Request samples

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

Response samples

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

Get a RuleSet by ID.

Get a RuleSet by ID.

+
path Parameters
id
required
integer

RuleSet ID

+

Responses

Response samples

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

Update a ruleset.

Update a ruleset.

+
path Parameters
id
required
integer

RuleSet ID

+
Request Body schema: application/json

RuleSet data

+
createTime
string
createUser
string
Array of objects (api.Ref)
description
string
id
integer
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule)
updateUser
string

Responses

Request samples

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

Delete a ruleset.

Delete a ruleset.

+
path Parameters
id
required
integer

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.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a setting.

Create a setting.

+
Request Body schema: application/json

Setting data

+
key
string
value
object

Responses

Request samples

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

Response samples

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

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": { }
}

Update a setting.

Update a setting.

+
path Parameters
key
required
string

Key

+

Responses

Create a setting.

Create a setting.

+
path Parameters
key
required
string

Key

+
Request Body schema: application/json

Setting value

+
key
string
value
object

Responses

Request samples

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

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.

+
Request Body schema: application/json

Stakeholder Group data

+
createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

Stakeholder Group ID

+
Request Body schema: application/json

Stakeholder Group data

+
createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
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.

+
path Parameters
id
required
integer

Stakeholder Group ID

+

Responses

stakeholders

List all stakeholders.

List all stakeholders.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder.

Create a stakeholder.

+
Request Body schema: application/json

Stakeholder data

+
Array of objects (api.Ref)
Array of objects (api.Ref)
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
Array of objects (api.Ref)
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

Stakeholder ID

+
Request Body schema: application/json

Stakeholder data

+
Array of objects (api.Ref)
Array of objects (api.Ref)
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
Array of objects (api.Ref)
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.

+
path Parameters
id
required
integer

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.

+
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)
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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)
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.

+
path Parameters
id
required
integer

Tag Category ID

+

Responses

List the tags in the tag category.

List the tags in the tag category.

+
path Parameters
id
required
integer

Tag Category ID

+
query Parameters
name
string

Optional tag name filter

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

targets

List all targets.

List all targets.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a target.

Create a target.

+
Request Body schema: application/json

Target data

+
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label)
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Get a Target by ID.

Get a Target by ID.

+
path Parameters
id
required
integer

Target ID

+

Responses

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Update a target.

Update a target.

+
path Parameters
id
required
integer

Target ID

+
Request Body schema: application/json

Target data

+
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label)
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Delete a target.

Delete a target.

+
path Parameters
id
required
integer

Target ID

+

Responses

taskgroups

List all task groups.

List all task groups.

+

Responses

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)
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.

+
path Parameters
id
required
integer

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.

+
path Parameters
id
required
integer

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)
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.

+
path Parameters
id
required
integer

TaskGroup ID

+

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. Returns index.html for directories when Accept=text/html else a tarball. ?filter=glob supports directory content filtering.

-
path Parameters
id
required
integer

TaskGroup ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

TaskGroup ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-

Responses

Submit a task group.

Submit a task group.

-
path Parameters
id
required
integer

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.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task.

Create a task.

-
Request Body schema: application/json

Task data

-
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError) [ items ]
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "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
integer

Task ID

-

Responses

Response samples

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

Update a task.

Update a task.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

Task data

-
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError) [ items ]
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

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

Delete a task.

Delete a task.

-
path Parameters
id
required
integer

Task ID

-

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. +

path Parameters
id
required
integer

TaskGroup ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

TaskGroup ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+

Responses

Submit a task group.

Submit a task group.

+
path Parameters
id
required
integer

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)
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.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task.

Create a task.

+
Request Body schema: application/json

Task data

+
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError)
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "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
integer

Task ID

+

Responses

Response samples

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

Update a task.

Update a task.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

Task data

+
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError)
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

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

Delete a task.

Delete a task.

+
path Parameters
id
required
integer

Task ID

+

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. Returns index.html for directories when Accept=text/html else a tarball. ?filter=glob supports directory content filtering.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-

Responses

Cancel a task.

Cancel a task.

-
path Parameters
id
required
integer

Task ID

-

Responses

Update a task report.

Update a task report.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

TaskReport data

-
activity
Array of strings
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError) [ items ]
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",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

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

Create a task report.

Update a task report.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

TaskReport data

-
activity
Array of strings
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError) [ items ]
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",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

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

Delete a task report.

Delete a task report.

-
path Parameters
id
required
integer

Task ID

-

Responses

Submit a task.

Submit a task.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

Task data (optional)

-
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError) [ items ]
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "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.

-
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-onprem"
lastUpdated
string
message
string
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",
  • "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",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Get a tracker by ID.

Get a tracker by ID.

-
path Parameters
id
required
integer

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",
  • "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-onprem"
lastUpdated
string
message
string
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",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Delete a tracker.

Delete a tracker.

-
path Parameters
id
required
integer

Tracker id

-

Responses

List a tracker's projects.

List a tracker's projects.

-
path Parameters
id
required
integer

Tracker ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a tracker project by ID.

Get a tracker project by ID.

-
path Parameters
id
required
integer

Tracker ID

-
id2
required
string

Project ID

-

Responses

Response samples

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

List a tracker project's issue types.

List a tracker project's issue types.

-
path Parameters
id
required
integer

Tracker ID

-
id2
required
string

Project ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]
+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+

Responses

Cancel a task.

Cancel a task.

+
path Parameters
id
required
integer

Task ID

+

Responses

Update a task report.

Update a task report.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

TaskReport data

+
activity
Array of strings
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError)
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",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

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

Create a task report.

Update a task report.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

TaskReport data

+
activity
Array of strings
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError)
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",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

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

Delete a task report.

Delete a task report.

+
path Parameters
id
required
integer

Task ID

+

Responses

Submit a task.

Submit a task.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

Task data (optional)

+
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError)
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "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.

+
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-onprem"
lastUpdated
string
message
string
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",
  • "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",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Get a tracker by ID.

Get a tracker by ID.

+
path Parameters
id
required
integer

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",
  • "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-onprem"
lastUpdated
string
message
string
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",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Delete a tracker.

Delete a tracker.

+
path Parameters
id
required
integer

Tracker id

+

Responses

List a tracker's projects.

List a tracker's projects.

+
path Parameters
id
required
integer

Tracker ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a tracker project by ID.

Get a tracker project by ID.

+
path Parameters
id
required
integer

Tracker ID

+
id2
required
string

Project ID

+

Responses

Response samples

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

List a tracker project's issue types.

List a tracker project's issue types.

+
path Parameters
id
required
integer

Tracker ID

+
id2
required
string

Project ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]