Data types reference

On this page
CloudBees SDM is a preview, with early access for select preview members. Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support. Learn more about the preview program.

The data types available in a CloudBees SDM user profile are a combination of those from the Common Data Model and those provided by apps installed in the user profile. The Common Data Model represents data entities and relationships in the simplest possible form in order to integrate processes across various systems and databases.

Refer to the Managing integrations with apps section for instructions on adding integration apps.

The reference below includes the data types that are currently available in all user profiles. These data types are used to build queries for reports and policies using the SDM query language.

Queries for reports may start with any of the queryable types and those for policies with any of the policy targets. Queries may then access nested or related types via the fields on those types. Where the required data is available, it is preferable to write queries against the interfaces defined in the Common Data Model. Doing so enables reports and policies to access data from any of the integration apps implementing those interfaces.

Queryable types

Queryable types are those that may be used as the starting point for writing a report.

Table 1. Queryable types

Type

Description

Feature

Features — the cornerstones of any decent piece of software

FeatureResource

Resource links associated with a feature

GithubBranch

A repository branch.

GithubCommit

Represents a Git commit.

GithubLabel

A Label.

GithubPullRequest

A repository pull request.

GithubPullRequestReview

A repository pull request review.

GithubRepository

A Github repository.

GithubReviewRequest

A request for a user to review a pull request.

GithubStatusContext

Represents an individual commit status context.

JenkinsBuild

Jenkins build

JenkinsFolder

Jenkins folder

JenkinsJob

Jenkins job

JenkinsMaster

Jenkins master

JiraBoard

Modeled after the GET /board/{boardId} returns documented at: https://developer.atlassian.com/cloud/jira/software/rest/#api-agile-1-0-board-boardId-get

JiraIssue

Mirrors the Jira IssueBean type documented at: https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-issue-issueIdOrKey-get

JiraIssueChangelogEntry

None

JiraIssueComment

Mirrors the Jira Comment type documented at: https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-issue-issueIdOrKey-comment-id-get

JiraServerIssue

Mirrors the Jira Issue type documented at: https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2/issue-getIssue

JiraServerIssueChangelogEntry

None

JiraServerIssueComment

Mirrors the Jira Comment type documented at: https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2/issue-getComments

JiraServerUser

Jira Server User - contains all PII associated with a Jira Server User

JiraSprint

Modeled after the GET /sprint returns documented at: https://developer.atlassian.com/cloud/jira/software/rest/#api-agile-1-0-sprint-sprintId-get

JiraUser

Jira User - contains all PII associated with a Jira user

Policy

Policy to evaluate against a target set of entities.

PolicyResult

Policy result.

PolicyStatusLabelAction

Policy action that provides a label for matching results.

Product

None

ValueStream

None

Policy targets

Policy targets are the types that may be used as the starting point for writing a policy.

Table 2. Policy Targets

Type

Description

GithubPullRequest

A repository pull request.

GithubRepository

A Github repository.

JenkinsBuild

Jenkins build

JenkinsJob

Jenkins job

JiraBoard

Modeled after the GET /board/{boardId} returns documented at: https://developer.atlassian.com/cloud/jira/software/rest/#api-agile-1-0-board-boardId-get

JiraIssue

Mirrors the Jira IssueBean type documented at: https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-issue-issueIdOrKey-get

JiraIssueChangelogEntry

None

JiraServerIssue

Mirrors the Jira Issue type documented at: https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2/issue-getIssue

JiraServerIssueChangelogEntry

None

JiraSprint

Modeled after the GET /sprint returns documented at: https://developer.atlassian.com/cloud/jira/software/rest/#api-agile-1-0-sprint-sprintId-get

Type details

Boolean (Scalar)

Built-in Boolean

Branch (Interface)

Branch Interface.

Table 3. Branch fields

Value

Type

Description

name

String

The name of the branch.

headCommit

Commit

Head commit of the branch.

Table 4. Fields where Branch is used

Type

Fields

Repository

Build (Interface)

Common data model for CI/CD Build

Table 5. Build fields

Value

Type

Description

startedAt

DateTime

When the build started

endedAt

DateTime

When the build ended

job

Job

Parent Job

displayName

String

Display Name

url

Url

URL

result

BuildResult

Build result

policyResults

List of PolicyResult

The results of evaluating policies against this target.

Table 6. Types implementing interface Build

Type

Description

JenkinsBuild

Jenkins build

Table 7. Fields where Build is used

Type

Fields

JenkinsJob

Job

BuildResult (Enum)

Build outcome

Table 8. BuildResult enumeration values

Value

Description

ABORTED

The build was manually aborted

FAILURE

The build had a fatal error

NOT_BUILT

The module was not built

SUCCESS

The build had no errors

UNSTABLE

The build had some errors but they were not fatal

Table 9. Fields where BuildResult is used

Type

Fields

Build

JenkinsBuild

Commit (Interface)

Commit interface.

Table 10. Commit fields

Value

Type

Description

hash

String

The commit hash.

statusContexts

List of CommitStatusContext

Associated Status contexts.

CommitStatusContext (Interface)

Represents an individual commit status context.

Table 11. CommitStatusContext fields

Value

Type

Description

state

CommitStatusState

The state of this status context.

context

String

The name of this status context.

description

String

The description for this status context

updatedAt

DateTime

Identifies the date and time when the object was last updated.

CommitStatusState (Enum)

The possible commit status states.

Table 12. CommitStatusState enumeration values

Value

Description

ERROR

Status is errored.

EXPECTED

Status is expected.

FAILURE

Status is failing.

PENDING

Status is pending.

SUCCESS

Status is successful.

Table 13. Fields where CommitStatusState is used

Type

Fields

CommitStatusContext

DateTime (Scalar)

An RFC-3339 compliant DateTime Scalar

Feature (Object)

Features — the cornerstones of any decent piece of software

Table 14. Feature fields

Value

Type

Description

name

String

The human readable name of the feature

description

String

Detailed description of the feature

stage

String

The feature stage, one of IN_PROGRESS, RECENTLY_RELEASED and UPCOMING

products

List of Product

Associated products

resources

List of FeatureResource

Associated resource URLs

jiraServerIssues

List of JiraServerIssue

Association JIRA Server issues

jiraIssues

List of JiraIssue

Association JIRA issues

Table 15. Fields where Feature is used

Type

Fields

JiraIssue

JiraServerIssue

Product

FeatureResource (Object)

Resource links associated with a feature

Table 16. FeatureResource fields

Value

Type

Description

title

String

Name of the resource

url

String

URL of the resource

Float (Scalar)

Built-in Float

GithubActor (Object)

The Github actor.

Table 17. GithubActor fields

Value

Type

Description

url

Url

The HTTP URL for this actor.

login

String

The username of the actor.

Table 18. Fields where GithubActor is used

Type

Fields

GithubPullRequest

GithubPullRequestReview

GithubBranch (Object)

A repository branch.

Table 19. GithubBranch fields

Value

Type

Description

branchId

String

Github Branch id.

branchKey

String

Branch unique key.

name

String

The branch name.

prefix

String

The Github ref’s prefix: refs/heads/.

headCommitId

String

Identifies the Github id of the head commit associated with the pull request, even if the ref has been deleted.

repositoryId

String

Github Repository id.

headCommitKey

String

Identifies the unique key of the head commit associated with the pull request, even if the ref has been deleted.

repositoryKey

String

Repository unique key.

repository

GithubRepository

Associated Repository.

headCommit

GithubCommit

Associated head commit.

Table 20. Fields where GithubBranch is used

Type

Fields

GithubRepository

GithubCommentAuthorAssociation (Enum)

A comment author association with repository.

Table 21. GithubCommentAuthorAssociation enumeration values

Value

Description

COLLABORATOR

Author has been invited to collaborate on the repository.

CONTRIBUTOR

Author has previously committed to the repository.

FIRST_TIMER

Author has not previously committed to Github.

FIRST_TIME_CONTRIBUTOR

Author has not previously committed to the repository.

MEMBER

Author is a member of the organization that owns the repository.

NONE

Author has no association with the repository.

OWNER

Author is the owner of the repository.

Table 22. Fields where GithubCommentAuthorAssociation is used

Type

Fields

GithubPullRequest

GithubPullRequestReview

GithubCommit (Object)

Represents a Git commit.

Table 23. GithubCommit fields

Value

Type

Description

commitId

String

Github Commit id

commitKey

String

Commit unique key

oid

String

The Git object ID

commitUrl

Url

The HTTP URL for this Git object

committedDate

DateTime

The datetime when this commit was committed.

message

String

The Git commit message

committer

GithubGitActor

Committership details of the commit.

author

GithubGitActor

Authorship details of the commit.

statusContexts

List of GithubStatusContext

Associated Status contexts.

Table 24. Fields where GithubCommit is used

Type

Fields

GithubPullRequest

GithubGitActor (Object)

Represents an actor in a Git commit (ie. an author or committer).

Table 25. GithubGitActor fields

Value

Type

Description

email

String

The email in the Git commit.

name

String

The name in the Git commit.

Table 26. Fields where GithubGitActor is used

Type

Fields

GithubCommit

GithubLabel (Object)

A Label.

Table 27. GithubLabel fields

Value

Type

Description

labelId

String

Github label id.

labelKey

String

label unique key.

name

String

The label name.

description

String

brief description of this label.

isDefault

Boolean

Indicates whether or not this is a default label.

color

String

Identifies the label color.

Table 28. Fields where GithubLabel is used

Type

Fields

GithubPullRequest

GithubLicense (Object)

A repository’s open source license

Table 29. GithubLicense fields

Value

Type

Description

key

String

The lowercased SPDX ID of the license

name

String

The license full name specified by https://spdx.org/licenses

spdxId

String

Short identifier specified by https://spdx.org/licenses

url

Url

URL to the license on https://choosealicense.com

Table 30. Fields where GithubLicense is used

Type

Fields

GithubRepository

GithubMergeStateStatus (Enum)

The possible detailed status information about a pull request merge.

Table 31. GithubMergeStateStatus enumeration values

Value

Description

BEHIND

The head ref is out of date.

BLOCKED

The merge is blocked.

CLEAN

Mergeable and passing commit status.

DIRTY

The merge commit cannot be cleanly created.

DRAFT

The merge is blocked due to the pull request being a draft.

HAS_HOOKS

Mergeable with passing commit status and pre-recieve hooks

UNKNOWN

The state cannot currently be determined.

UNSTABLE

Mergeable with non-passing commit status.

Table 32. Fields where GithubMergeStateStatus is used

Type

Fields

GithubPullRequest

GithubMergeableState (Enum)

Whether or not a PullRequest can be merged.

Table 33. GithubMergeableState enumeration values

Value

Description

CONFLICTING

The pull request cannot be merged due to merge conflicts.

MERGEABLE

The pull request can be merged.

UNKNOWN

The mergeability of the pull request is still being calculated.

Table 34. Fields where GithubMergeableState is used

Type

Fields

GithubPullRequest

GithubPullRequest (Object)

A repository pull request.

Table 35. GithubPullRequest fields

Value

Type

Description

pullRequestId

String

Github PullRequest id.

pullRequestKey

String

PullRequest unique key.

additions

Int

The number of additions in this pull request.

authorAssociation

GithubCommentAuthorAssociation

Author’s association with the subject of the comment.

baseRefName

String

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

baseRefOid

String

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

bodyText

String

The body rendered to text.

changedFiles

Int

The number of changed files in this pull request.

closed

Boolean

true if the pull request is closed

closedAt

DateTime

Identifies the date and time when the object was closed.

createdAt

DateTime

Identifies the date and time when the object was created.

databaseId

Int

Identifies the primary key from the database.

deletions

Int

The number of deletions in this pull request.

headRefName

String

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

headRefOid

String

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

headCommitId

String

Identifies the Github id of the head commit associated with the pull request, even if the ref has been deleted.

headCommitKey

String

Identifies the unique key of the head commit associated with the pull request, even if the ref has been deleted.

isDraft

Boolean

Identifies if the pull request is a draft.

locked

Boolean

true if the pull request is locked

maintainerCanModify

Boolean

Indicates whether maintainers can modify the pull request.

mergeable

GithubMergeableState

Whether or not the pull request can be merged based on the existence of merge conflicts.

merged

Boolean

Whether or not the pull request was merged.

mergedAt

DateTime

The date and time that the pull request was merged.

mergeStateStatus

GithubMergeStateStatus

The detailed status information about a pull request merge.

number

Int

Identifies the pull request number.

state

GithubPullRequestState

Identifies the state of the pull request.

title

String

Identifies the pull request title.

updatedAt

DateTime

Identifies the date and time when the object was last updated.

url

Url

The HTTP URL for this pull request.

headRef

String

The Git head ref on the associated Repository that can be used to fetch this Pull Request.

author

GithubActor

The actor who authored the comment.

labelIds

List of String

Github label ids.

labelKeys

List of String

Label unique keys.

repositoryId

String

Github Repository id.

repositoryKey

String

Repository unique key.

repository

GithubRepository

Associated Repository.

policyResults

List of PolicyResult

The results of evaluating policies against this target.

jiraIssueIds

List of String

Jira Issue ids/keys.

jiraIssues

List of JiraIssue

Associated Jira Issues.

jiraServerIssues

List of JiraServerIssue

Associated Jira Server Issues.

jenkinsJobs

List of JenkinsJob

The JenkinsJobs that are building this Pull Request.

headCommit

GithubCommit

Associated head commit.

labels

List of GithubLabel

Associated Labels.

pullRequestReviews

List of GithubPullRequestReview

Associated Pull Request Reviews.

jenkinsXPipelineActivities

List of JenkinsXPipelineActivity

jenkinsXPipelineActivities is the Jenkins X pipelines runs that built this pull request

reviewRequestKeys

List of String

Review Request unique key. This is not intended to be used by the end-user

reviewRequests

List of GithubReviewRequest

Associated Review Requests.

Table 36. Fields where GithubPullRequest is used

Type

Fields

GithubPullRequestReview

GithubRepository

JenkinsJob

JiraIssue

JiraServerIssue

GithubPullRequestReview (Object)

A repository pull request review.

Table 37. GithubPullRequestReview fields

Value

Type

Description

author

GithubActor

The actor who authored the comment.

authorAssociation

GithubCommentAuthorAssociation

Author’s association with the subject of the comment.

bodyText

String

The body of this review rendered as plain text.

commitId

String

Github commit id.

commitKey

String

Commit unique key.

databaseId

Int

Identifies the primary key from the database.

pullRequestId

String

Github pull request id.

repositoryId

String

Github repository id.

pullRequestKey

String

Pull request unique key.

pullRequest

GithubPullRequest

Associated Pull Request.

repositoryKey

String

Repository unique key.

repository

GithubRepository

Associated Repository.

state

GithubPullRequestReviewState

Identifies the current state of the pull request review.

submittedAt

DateTime

Identifies when the Pull Request Review was submitted

url

Url

The HTTP URL permalink for this PullRequestReview.

Table 38. Fields where GithubPullRequestReview is used

Type

Fields

GithubRepository

GithubPullRequestReviewState (Enum)

The possible states of a pull request review.

Table 39. GithubPullRequestReviewState enumeration values

Value

Description

APPROVED

A review allowing the pull request to merge.

CHANGES_REQUESTED

A review blocking the pull request from merging.

COMMENTED

An informational review.

DISMISSED

A review that has been dismissed.

PENDING

A review that has not yet been submitted.

Table 40. Fields where GithubPullRequestReviewState is used

Type

Fields

GithubPullRequestReview

GithubPullRequestState (Enum)

The possible states of a pull request.

Table 41. GithubPullRequestState enumeration values

Value

Description

CLOSED

A pull request that has been closed without being merged.

MERGED

A pull request that has been closed by being merged.

OPEN

A pull request that is still open.

Table 42. Fields where GithubPullRequestState is used

Type

Fields

GithubPullRequest

GithubRepository (Object)

A Github repository.

Table 43. GithubRepository fields

Value

Type

Description

name

String

The name of the repository.

isArchived

Boolean

Indicates if the repository is unmaintained.

isDisabled

Boolean

Returns whether or not this repository disabled.

isFork

Boolean

Identifies if the repository is a fork.

isMirror

Boolean

Identifies if the repository is a mirror.

isPrivate

Boolean

Identifies if the repository is private.

sshUrl

String

The SSH URL to clone this repository

pushedAt

DateTime

Identifies when the repository was last pushed to.

createdAt

DateTime

Identifies the date and time when the object was created.

forkCount

Int

Returns how many forks there are of this repository in the whole network.

mirrorUrl

Url

The repository’s original mirror URL.

updatedAt

DateTime

Identifies the date and time when the object was last updated.

url

Url

The HTTP URL for this repository

gitUri

String

The Git URI ('git://…​'), or unique identifer of this Repository.

databaseId

Int

Identifies the primary key from the database.

licenseInfo

GithubLicense

The license associated with the repository

description

String

The description of the repository.

homepageUrl

Url

The repository’s URL.

nameWithOwner

String

The repository’s name with owner.

installationId

Int

The Github application installation Id.

hasIssuesEnabled

Boolean

Indicates if the repository has issues feature enabled.

hasWikiEnabled

Boolean

Indicates if the repository has wiki feature enabled.

owner

GithubRepositoryOwner

The User owner of the repository.

repositoryId

String

Github Repository id.

defaultBranchId

String

Github default Branch id.

repositoryKey

String

Repository unique key.

defaultBranchKey

String

Default Branch unique key.

defaultBranchName

String

Github default Branch name.

policyResults

List of PolicyResult

The results of evaluating policies against this target.

products

List of Product

Products associated with the GitHub repository

pullRequests

List of GithubPullRequest

Associated Pull Requests.

defaultBranchRef

GithubBranch

Associated Default Branch.

branches

List of GithubBranch

Associated Branches.

pullRequestReviews

List of GithubPullRequestReview

Associated Pull Request Reviews.

jenkinsXPipelineActivities

List of JenkinsXPipelineActivity

jenkinsXPipelineActivities is the Jenkins X pipelines runs that built this repository

Table 44. Fields where GithubRepository is used

Type

Fields

Product

GithubRepositoryOwner (Object)

Represents an owner of a Repository.

Table 45. GithubRepositoryOwner fields

Value

Type

Description

login

String

The username used to login.

name

String

The display name of the owner.

url

Url

The HTTP URL for the owner.

type

String

The owner’s type.

Table 46. Fields where GithubRepositoryOwner is used

Type

Fields

GithubRepository

GithubRequestedReviewer (Object)

The requested reviewers.

Table 47. GithubRequestedReviewer fields

Value

Type

Description

url

Url

The HTTP URL for this requested reviewer.

login

String

The username of the requested reviewer.

name

String

The name of the requested reviewer.

Table 48. Fields where GithubRequestedReviewer is used

Type

Fields

GithubReviewRequest

GithubReviewRequest (Object)

A request for a user to review a pull request.

Table 49. GithubReviewRequest fields

Value

Type

Description

reviewRequestKey

String

label unique key.

requestedReviewer

GithubRequestedReviewer

The reviewer that is requested.

GithubStatusContext (Object)

Represents an individual commit status context.

Table 50. GithubStatusContext fields

Value

Type

Description

commitId

String

Github commit id.

commitKey

String

Commit unique key.

state

GithubStatusState

The state of this status context.

context

String

The name of this status context.

description

String

The description for this status context

targetUrl

Url

The URL for this status context.

updatedAt

DateTime

Identifies the date and time when the object was last updated.

GithubStatusState (Enum)

The possible commit status states.

Table 51. GithubStatusState enumeration values

Value

Description

ERROR

Status is errored.

EXPECTED

Status is expected.

FAILURE

Status is failing.

PENDING

Status is pending.

SUCCESS

Status is successful.

Table 52. Fields where GithubStatusState is used

Type

Fields

GithubStatusContext

ID (Scalar)

Built-in ID

Int (Scalar)

Built-in Int

Issue (Interface)

The interface type for issues.

Table 53. Issue fields

Value

Type

Description

issueId

String

Human readable issue key/string e.g. ACME-1234 for Jira

summary

String

Issue summary

description

String

Issue description/details

comments

List of IssueComment

Set of comments made on the issue

Table 54. Types implementing interface Issue

Type

Description

JiraIssue

Mirrors the Jira IssueBean type documented at: https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-issue-issueIdOrKey-get

JiraServerIssue

Mirrors the Jira Issue type documented at: https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2/issue-getIssue

Table 55. Fields where Issue is used

Type

Fields

IssueComment

JiraIssueComment

JiraServerIssueComment

IssueComment (Interface)

The interface type for issues comments.

Table 56. IssueComment fields

Value

Type

Description

issue

Issue

The comment’s issue

body

String

The body of the issue comment

Table 57. Types implementing interface IssueComment

Type

Description

JiraIssueComment

Mirrors the Jira Comment type documented at: https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-issue-issueIdOrKey-comment-id-get

JiraServerIssueComment

Mirrors the Jira Comment type documented at: https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2/issue-getComments

Table 58. Fields where IssueComment is used

Type

Fields

JiraIssue

JiraServerIssue

JenkinsBuild (Object)

Jenkins build

Table 59. JenkinsBuild fields

Value

Type

Description

number

Int

Build number

displayName

String

Display Name

result

BuildResult

Result

url

Url

URL (Classic UI)

displayUrl

Url

URL for redirect to preferred UI (if Blue Ocean installed)

masterInstanceId

String

Master instance ID

startedAt

DateTime

When the build started

endedAt

DateTime

When the build ended

duration

Int

Duration (in ms)

master

JenkinsMaster

Master

jobFullName

String

Job full name

policyResults

List of PolicyResult

The results of evaluating policies against this target

job

Job

Job

jenkinsJob

JenkinsJob

JenkinsJob

Table 60. Interfaces implemented by JenkinsBuild

Type

Description

Build

Common data model for CI/CD Build

Table 61. Fields where JenkinsBuild is used

Type

Fields

JenkinsJob

JenkinsFolder (Object)

Jenkins folder

Table 62. JenkinsFolder fields

Value

Type

Description

name

String

Name

fullName

String

Full name

type

String

Type (e.g. class name for folder, org folder or multi-branch)

organization

String

Organization (for an org folder)

repository

Url

Repository (for a multi-branch folder)

masterInstanceId

String

Master instance ID

master

JenkinsMaster

Master

parentFullName

String

Parent folder full name (null if top-level folder)

parent

JenkinsFolder

Parent folder (null if top-level folder)

children

List of JenkinsFolder

List of folder that are direct children of this folder

childJobs

List of JenkinsJob

List of jobs that are direct children of this folder

Table 63. Fields where JenkinsFolder is used

Type

Fields

JenkinsFolder

JenkinsJob

JenkinsMaster

JenkinsJob (Object)

Jenkins job

Table 64. JenkinsJob fields

Value

Type

Description

name

String

Name

fullName

String

Full name

displayName

String

Full display name taking into account any parent folders

shortDisplayName

String

Display name relative to parent folder

type

String

Type (e.g. freestyle or pipeline class name)

url

Url

URL (Classic UI)

displayUrl

Url

URL for redirect to preferred UI (if Blue Ocean installed)

scmUrl

String

SCM URL (if present)

scmUri

String

SCM URI (if present)

scmBranch

String

SCM Branch (if present and not already part of the URL)

headSpecs

List of String

The heads/references that will be fetched

masterInstanceId

String

Master instance ID

master

JenkinsMaster

Master

parentFullName

String

Parent folder full name (null if top-level job)

parent

JenkinsFolder

Parent folder (null if top-level job)

policyResults

List of PolicyResult

The results of evaluating policies against this target

builds

List of Build

Builds

jenkinsBuilds

List of JenkinsBuild

Jenkins Builds

products

List of Product

Products associated with the Jenkins job

pullRequest

GithubPullRequest

None

Table 65. Interfaces implemented by JenkinsJob

Type

Description

Job

Common data model for CI/CD Job

Table 66. Fields where JenkinsJob is used

Type

Fields

JenkinsMaster

JenkinsMaster (Object)

Jenkins master

Table 67. JenkinsMaster fields

Value

Type

Description

instanceId

String

Instance ID

url

Url

URL

displayName

String

Display name (if connected to CJOC)

allFolders

List of JenkinsFolder

List of all folders on this master

allJobs

List of JenkinsJob

List of all jobs on this master

JiraBoard (Object)

Modeled after the GET /board/{boardId} returns documented at: https://developer.atlassian.com/cloud/jira/software/rest/#api-agile-1-0-board-boardId-get

Table 68. JiraBoard fields

Value

Type

Description

self

String

None

jiraBoardId

Int

None

name

String

None

type

JiraBoardType

None

location

JiraBoardLocation

None

jiraSprintIds

List of Int

None

jiraSprints

List of JiraSprint

None

policyResults

List of PolicyResult

The results of evaluating policies against this target

Table 69. Fields where JiraBoard is used

Type

Fields

JiraSprint

JiraBoardLocation (Object)

Table 70. JiraBoardLocation fields

Value

Type

Description

projectId

Int

None

displayName

String

None

projectName

String

None

projectKey

String

None

projectTypeKey

JiraProjectType

None

avatarURI

String

None

name

String

None

Table 71. Fields where JiraBoardLocation is used

Type

Fields

JiraBoard

JiraBoardType (Enum)

Jira board types

Table 72. JiraBoardType enumeration values

Value

Description

kanban

None

scrum

None

simple

None

Table 73. Fields where JiraBoardType is used

Type

Fields

JiraBoard

JiraIssue (Object)

Table 74. JiraIssue fields

Value

Type

Description

self

String

None

jiraIssueId

String

None

cloudbeesJiraIssueId

String

Synthetic issueId built from clientKey-jiraIssueId for distinguishing issues from different instances

fields

JiraIssueFields

None

renderedFields

JiraIssueRenderedFields

None

key

String

None

jiraIssueKey

String

None

assigneeAccountId

String

User fields - info stored separately in JiraUser type for GDPR readiness

assignee

JiraUser

None

creatorAccountId

String

None

creator

JiraUser

None

reporterAccountId

String

None

reporter

JiraUser

None

policyResults

List of PolicyResult

The results of evaluating policies against this target

epicLink

String

None

epic

JiraIssue

None

epicIssues

List of JiraIssue

None

features

List of Feature

The feature or features that this Jira issue is associated with

sprint

String

None

jiraSprintIds

List of Int

None

jiraSprints

List of JiraSprint

None

issueId

String

Interface compatability fields

summary

String

None

description

String

None

comments

List of IssueComment

Comments for a JiraIssue

jiraComments

List of JiraIssueComment

Temporary backwards compatibility field for non-interface relationship

pullRequests

List of GithubPullRequest

Associated Pull Requests.

changelog

List of JiraIssueChangelogEntry

The associated Jira Issue changelog

Table 75. Interfaces implemented by JiraIssue

Type

Description

Issue

The interface type for issues.

Table 76. Fields where JiraIssue is used

Type

Fields

JiraIssue

JiraIssueChangelogEntry

JiraIssueComment

JiraSprint

JiraIssueAttachment (Object)

Table 77. JiraIssueAttachment fields

Value

Type

Description

self

String

None

filename

String

None

created

DateTime

None

size

Int

None

mimeType

String

None

content

String

None

Table 78. Fields where JiraIssueAttachment is used

Type

Fields

JiraIssueFields

JiraIssueAvatarUrls (Object)

Table 79. JiraIssueAvatarUrls fields

Value

Type

Description

_16x16

String

None

_32x32

String

None

_48x48

String

None

_24x24

String

None

Table 80. Fields where JiraIssueAvatarUrls is used

Type

Fields

JiraIssueProject

JiraIssueChangelogEntry (Object)

Table 81. JiraIssueChangelogEntry fields

Value

Type

Description

key

String

None

jiraIssueChangelogEntryId

String

The numerical changelog entry id

self

String

The URL of the changelog in the Jira Cloud Rest API

issueId

Int

The Jira issue id this changelog is associated with, unique to a Jira Cloud instance

cloudbeesJiraIssueId

String

Synthetic issueId built from clientKey-jiraIssueId for distinguishing issues from different instances

authorAccountId

String

The account id of the Jira Cloud user making the change

author

JiraUser

Link to the Jira Cloud user making the change

created

DateTime

Time this change was executed

items

List of JiraIssueChangelogItem

The list of items changed

jiraIssue

JiraIssue

Link to the associated Jira Issue

policyResults

List of PolicyResult

The results of evaluating policies against this target

JiraIssueChangelogItem (Object)

Table 82. JiraIssueChangelogItem fields

Value

Type

Description

field

String

The name of the field changed.

fieldtype

String

The type of the field changed.

fieldId

String

The ID of the field changed.

from

String

The details of the original value.

fromString

String

The details of the original value as a string.

to

String

The details of the new value.

toString

String

The details of the new value as a string.

Table 83. Fields where JiraIssueChangelogItem is used

Type

Fields

JiraIssueChangelogEntry

JiraIssueComment (Object)

Table 84. JiraIssueComment fields

Value

Type

Description

key

String

None

jiraIssueId

String

None

cloudbeesJiraIssueId

String

Synthetic issueId built from clientKey-jiraIssueId for distinguishing issues from different instances

jiraIssueKey

String

None

jiraIssue

JiraIssue

None

self

String

None

authorAccountId

String

None

author

JiraUser

None

body

String

None

renderedBody

String

None

updateAuthorAccountId

String

None

updateAuthor

JiraUser

None

created

DateTime

None

updated

DateTime

None

issue

Issue

Interface relationship field

Table 85. Interfaces implemented by JiraIssueComment

Type

Description

IssueComment

The interface type for issues comments.

JiraIssueComponents (Object)

Table 86. JiraIssueComponents fields

Value

Type

Description

self

String

None

name

String

None

Table 87. Fields where JiraIssueComponents is used

Type

Fields

JiraIssueFields

JiraIssueFields (Object)

Table 88. JiraIssueFields fields

Value

Type

Description

statuscategorychangedate

DateTime

None

issuetype

JiraIssueIssuetype

None

project

JiraIssueProject

None

summary

String

None

created

DateTime

None

priority

JiraIssuePriority

None

issuelinks

List of JiraIssueIssuelinks

None

updated

DateTime

None

status

JiraIssueStatus

None

description

String

None

resolution

JiraIssueResolution

None

resolutiondate

DateTime

None

labels

List of String

None

components

List of JiraIssueComponents

None

timespent

Int

None

fixVersions

List of JiraIssueFixVersion

None

aggregatetimespent

Int

None

workratio

Int

None

lastViewed

String

None

watches

JiraIssueWatches

None

timeestimate

Int

None

versions

List of JiraIssueFixVersion

None

timeoriginalestimate

Int

None

timetracking

JiraIssueTimeTracking

None

aggregatetimeestimate

Int

None

attachment

List of JiraIssueAttachment

None

aggregateprogress

JiraIssueProgress

None

progress

JiraIssueProgress

None

votes

JiraIssueVotes

None

epicLink

String

None

rank

String

None

subtasks

List of JiraIssueSubtask

None

storyPoints

Float

None

Table 89. Fields where JiraIssueFields is used

Type

Fields

JiraIssue

JiraIssueInwardIssue

JiraIssueOutwardIssue

JiraIssueFixVersion (Object)

Table 90. JiraIssueFixVersion fields

Value

Type

Description

self

String

None

description

String

None

name

String

None

archived

Boolean

None

released

Boolean

None

releaseDate

String

None

Table 91. Fields where JiraIssueFixVersion is used

Type

Fields

JiraIssueFields

JiraIssueInwardIssue (Object)

Table 92. JiraIssueInwardIssue fields

Value

Type

Description

self

String

None

fields

JiraIssueFields

None

jiraIssueKey

String

None

Table 93. Fields where JiraIssueInwardIssue is used

Type

Fields

JiraIssueIssuelinks

Table 94. JiraIssueIssuelinks fields

Value

Type

Description

outwardIssue

JiraIssueOutwardIssue

None

inwardIssue

JiraIssueInwardIssue

None

self

String

None

type

JiraIssueIssuetype

None

Table 95. Fields where JiraIssueIssuelinks is used

Type

Fields

JiraIssueFields

JiraIssueIssuetype (Object)

Table 96. JiraIssueIssuetype fields

Value

Type

Description

avatarId

Int

None

name

String

None

self

String

None

description

String

None

iconUrl

String

None

subtask

Boolean

None

inward

String

None

outward

String

None

Table 97. Fields where JiraIssueIssuetype is used

Type

Fields

JiraIssueFields

JiraIssueIssuelinks

JiraIssueSubtaskFields

JiraIssueOutwardIssue (Object)

Table 98. JiraIssueOutwardIssue fields

Value

Type

Description

self

String

None

fields

JiraIssueFields

None

jiraIssueKey

String

None

Table 99. Fields where JiraIssueOutwardIssue is used

Type

Fields

JiraIssueIssuelinks

JiraIssuePriority (Object)

Table 100. JiraIssuePriority fields

Value

Type

Description

name

String

None

self

String

None

iconUrl

String

None

Table 101. Fields where JiraIssuePriority is used

Type

Fields

JiraIssueFields

JiraIssueSubtaskFields

JiraIssueProgress (Object)

Table 102. JiraIssueProgress fields

Value

Type

Description

progress

Int

None

total

Int

None

percent

Int

None

Table 103. Fields where JiraIssueProgress is used

Type

Fields

JiraIssueFields

JiraIssueProject (Object)

Table 104. JiraIssueProject fields

Value

Type

Description

simplified

Boolean

None

name

String

None

self

String

None

projectTypeKey

String

None

key

String

None

avatarUrls

JiraIssueAvatarUrls

None

Table 105. Fields where JiraIssueProject is used

Type

Fields

JiraIssueFields

JiraIssueRenderedFields (Object)

Table 106. JiraIssueRenderedFields fields

Value

Type

Description

description

String

None

Table 107. Fields where JiraIssueRenderedFields is used

Type

Fields

JiraIssue

JiraIssueResolution (Object)

Table 108. JiraIssueResolution fields

Value

Type

Description

self

String

None

description

String

None

name

String

None

Table 109. Fields where JiraIssueResolution is used

Type

Fields

JiraIssueFields

JiraIssueStatus (Object)

Table 110. JiraIssueStatus fields

Value

Type

Description

name

String

None

self

String

None

description

String

None

iconUrl

String

None

statusCategory

JiraIssueStatusCategory

None

Table 111. Fields where JiraIssueStatus is used

Type

Fields

JiraIssueFields

JiraIssueSubtaskFields

JiraIssueStatusCategory (Object)

Table 112. JiraIssueStatusCategory fields

Value

Type

Description

name

String

None

key

String

None

colorName

String

None

self

String

None

Table 113. Fields where JiraIssueStatusCategory is used

Type

Fields

JiraIssueStatus

JiraIssueSubtask (Object)

Table 114. JiraIssueSubtask fields

Value

Type

Description

self

String

None

key

String

None

fields

JiraIssueSubtaskFields

None

Table 115. Fields where JiraIssueSubtask is used

Type

Fields

JiraIssueFields

JiraIssueSubtaskFields (Object)

Table 116. JiraIssueSubtaskFields fields

Value

Type

Description

summary

String

None

status

JiraIssueStatus

None

priority

JiraIssuePriority

None

issuetype

JiraIssueIssuetype

None

Table 117. Fields where JiraIssueSubtaskFields is used

Type

Fields

JiraIssueSubtask

JiraIssueTimeTracking (Object)

Table 118. JiraIssueTimeTracking fields

Value

Type

Description

remainingEstimate

String

None

timeSpent

String

None

remainingEstimateSeconds

Int

None

timeSpentSeconds

Int

None

Table 119. Fields where JiraIssueTimeTracking is used

Type

Fields

JiraIssueFields

JiraIssueVotes (Object)

Table 120. JiraIssueVotes fields

Value

Type

Description

self

String

None

votes

Int

None

hasVoted

Boolean

None

Table 121. Fields where JiraIssueVotes is used

Type

Fields

JiraIssueFields

JiraIssueWatches (Object)

Table 122. JiraIssueWatches fields

Value

Type

Description

self

String

None

watchCount

Int

None

isWatching

Boolean

None

Table 123. Fields where JiraIssueWatches is used

Type

Fields

JiraIssueFields

JiraProjectType (Enum)

Jira project types

Table 124. JiraProjectType enumeration values

Value

Description

business

None

service_desk

None

software

None

Table 125. Fields where JiraProjectType is used

Type

Fields

JiraBoardLocation

JiraServerIssue (Object)

Table 126. JiraServerIssue fields

Value

Type

Description

self

String

None

jiraIssueId

String

None

cloudbeesJiraIssueId

String

Synthetic issueId built from clientKey-jiraIssueId for distinguishing issues from different instances

fields

JiraServerIssueFields

None

renderedFields

JiraServerIssueRenderedFields

None

key

String

None

jiraIssueKey

String

None

assigneeKey

String

User fields - info stored separately in JiraServerUser type for GDPR readiness

assignee

JiraServerUser

None

creatorKey

String

None

creator

JiraServerUser

None

reporterKey

String

None

reporter

JiraServerUser

None

policyResults

List of PolicyResult

The results of evaluating policies against this target

epicLink

String

None

epic

JiraServerIssue

None

epicIssues

List of JiraServerIssue

None

features

List of Feature

The feature or features that this Jira Server issue is associated with

sprint

String

None

jiraSprintIds

List of Int

None

jiraSprints

List of JiraSprint

None

issueId

String

Interface compatability fields

summary

String

None

description

String

None

comments

List of IssueComment

Comments for a JiraServerIssue

jiraComments

List of JiraServerIssueComment

Temporary backwards compatibility field for non-interface relationship

pullRequests

List of GithubPullRequest

Associated Pull Requests.

changelog

List of JiraServerIssueChangelogEntry

The associated Jira Server Issue changelog

Table 127. Interfaces implemented by JiraServerIssue

Type

Description

Issue

The interface type for issues.

Table 128. Fields where JiraServerIssue is used

Type

Fields

JiraServerIssue

JiraServerIssueChangelogEntry

JiraServerIssueComment

JiraSprint

JiraServerIssueAttachment (Object)

Table 129. JiraServerIssueAttachment fields

Value

Type

Description

self

String

None

filename

String

None

created

DateTime

None

size

Int

None

mimeType

String

None

content

String

None

Table 130. Fields where JiraServerIssueAttachment is used

Type

Fields

JiraServerIssueFields

JiraServerIssueAvatarUrls (Object)

Table 131. JiraServerIssueAvatarUrls fields

Value

Type

Description

_16x16

String

None

_32x32

String

None

_48x48

String

None

_24x24

String

None

Table 132. Fields where JiraServerIssueAvatarUrls is used

Type

Fields

JiraServerIssueProject

JiraServerIssueChangelogEntry (Object)

Table 133. JiraServerIssueChangelogEntry fields

Value

Type

Description

key

String

None

jiraServerIssueChangelogEntryId

String

The numerical changelog entry id

self

String

The URL of the changelog in the Jira Cloud Rest API

issueId

Int

The Jira issue id this changelog is associated with, unique to a Jira Cloud instance

cloudbeesJiraIssueId

String

Synthetic issueId built from clientKey-jiraServerIssueId for distinguishing issues from different instances

authorKey

String

The account key of the Jira Server user making the change

author

JiraServerUser

Link to the Jira Server user making the change

created

DateTime

Time this change was executed

items

List of JiraServerIssueChangelogItem

The list of items changed

jiraServerIssue

JiraServerIssue

Link to the associated Jira Issue

policyResults

List of PolicyResult

The results of evaluating policies against this target

JiraServerIssueChangelogItem (Object)

Table 134. JiraServerIssueChangelogItem fields

Value

Type

Description

field

String

The name of the field changed.

fieldtype

String

The type of the field changed.

fieldId

String

The ID of the field changed.

from

String

The details of the original value.

fromString

String

The details of the original value as a string.

to

String

The details of the new value.

toString

String

The details of the new value as a string.

Table 135. Fields where JiraServerIssueChangelogItem is used

Type

Fields

JiraServerIssueChangelogEntry

JiraServerIssueComment (Object)

Table 136. JiraServerIssueComment fields

Value

Type

Description

key

String

None

jiraIssueId

String

None

cloudbeesJiraIssueId

String

Synthetic issueId built from clientKey-jiraIssueId for distinguishing issues from different instances

jiraIssueKey

String

None

jiraIssue

JiraServerIssue

None

self

String

None

authorKey

String

None

author

JiraServerUser

None

body

String

None

renderedBody

String

None

updateAuthorKey

String

None

updateAuthor

JiraServerUser

None

created

DateTime

None

updated

DateTime

None

issue

Issue

Interface relationship field

Table 137. Interfaces implemented by JiraServerIssueComment

Type

Description

IssueComment

The interface type for issues comments.

JiraServerIssueComponents (Object)

Table 138. JiraServerIssueComponents fields

Value

Type

Description

self

String

None

name

String

None

Table 139. Fields where JiraServerIssueComponents is used

Type

Fields

JiraServerIssueFields

JiraServerIssueFields (Object)

Table 140. JiraServerIssueFields fields

Value

Type

Description

statuscategorychangedate

DateTime

None

issuetype

JiraServerIssueIssuetype

None

project

JiraServerIssueProject

None

summary

String

None

created

DateTime

None

priority

JiraServerIssuePriority

None

issuelinks

List of JiraServerIssueIssuelinks

None

updated

DateTime

None

status

JiraServerIssueStatus

None

description

String

None

resolution

JiraServerIssueResolution

None

resolutiondate

DateTime

None

labels

List of String

None

components

List of JiraServerIssueComponents

None

timespent

Int

None

fixVersions

List of JiraServerIssueFixVersion

None

aggregatetimespent

Int

None

workratio

Int

None

lastViewed

String

None

watches

JiraServerIssueWatches

None

timeestimate

Int

None

versions

List of JiraServerIssueFixVersion

None

timeoriginalestimate

Int

None

timetracking

JiraServerIssueTimeTracking

None

aggregatetimeestimate

Int

None

attachment

List of JiraServerIssueAttachment

None

aggregateprogress

JiraServerIssueProgress

None

progress

JiraServerIssueProgress

None

votes

JiraServerIssueVotes

None

epicLink

String

None

rank

String

None

subtasks

List of JiraServerIssueSubtask

None

storyPoints

Float

None

Table 141. Fields where JiraServerIssueFields is used

Type

Fields

JiraServerIssue

JiraServerIssueInwardIssue

JiraServerIssueOutwardIssue

JiraServerIssueFixVersion (Object)

Table 142. JiraServerIssueFixVersion fields

Value

Type

Description

self

String

None

description

String

None

name

String

None

archived

Boolean

None

released

Boolean

None

releaseDate

DateTime

None

Table 143. Fields where JiraServerIssueFixVersion is used

Type

Fields

JiraServerIssueFields

JiraServerIssueInwardIssue (Object)

Table 144. JiraServerIssueInwardIssue fields

Value

Type

Description

self

String

None

fields

JiraServerIssueFields

None

jiraIssueKey

String

None

Table 145. Fields where JiraServerIssueInwardIssue is used

Type

Fields

JiraServerIssueIssuelinks

Table 146. JiraServerIssueIssuelinks fields

Value

Type

Description

outwardIssue

JiraServerIssueOutwardIssue

None

inwardIssue

JiraServerIssueInwardIssue

None

self

String

None

type

JiraServerIssueIssuetype

None

Table 147. Fields where JiraServerIssueIssuelinks is used

Type

Fields

JiraServerIssueFields

JiraServerIssueIssuetype (Object)

Table 148. JiraServerIssueIssuetype fields

Value

Type

Description

avatarId

Int

None

name

String

None

self

String

None

description

String

None

iconUrl

String

None

subtask

Boolean

None

Table 149. Fields where JiraServerIssueIssuetype is used

Type

Fields

JiraServerIssueFields

JiraServerIssueIssuelinks

JiraServerIssueSubtaskFields

JiraServerIssueOutwardIssue (Object)

Table 150. JiraServerIssueOutwardIssue fields

Value

Type

Description

self

String

None

fields

JiraServerIssueFields

None

jiraIssueKey

String

None

Table 151. Fields where JiraServerIssueOutwardIssue is used

Type

Fields

JiraServerIssueIssuelinks

JiraServerIssuePriority (Object)

Table 152. JiraServerIssuePriority fields

Value

Type

Description

name

String

None

self

String

None

iconUrl

String

None

Table 153. Fields where JiraServerIssuePriority is used

Type

Fields

JiraServerIssueFields

JiraServerIssueSubtaskFields

JiraServerIssueProgress (Object)

Table 154. JiraServerIssueProgress fields

Value

Type

Description

progress

Int

None

total

Int

None

percent

Int

None

Table 155. Fields where JiraServerIssueProgress is used

Type

Fields

JiraServerIssueFields

JiraServerIssueProject (Object)

Table 156. JiraServerIssueProject fields

Value

Type

Description

name

String

None

self

String

None

key

String

None

avatarUrls

JiraServerIssueAvatarUrls

None

Table 157. Fields where JiraServerIssueProject is used

Type

Fields

JiraServerIssueFields

JiraServerIssueRenderedFields (Object)

Table 158. JiraServerIssueRenderedFields fields

Value

Type

Description

description

String

None

Table 159. Fields where JiraServerIssueRenderedFields is used

Type

Fields

JiraServerIssue

JiraServerIssueResolution (Object)

Table 160. JiraServerIssueResolution fields

Value

Type

Description

self

String

None

description

String

None

name

String

None

Table 161. Fields where JiraServerIssueResolution is used

Type

Fields

JiraServerIssueFields

JiraServerIssueStatus (Object)

Table 162. JiraServerIssueStatus fields

Value

Type

Description

name

String

None

self

String

None

description

String

None

iconUrl

String

None

statusCategory

JiraServerIssueStatusCategory

None

Table 163. Fields where JiraServerIssueStatus is used

Type

Fields

JiraServerIssueFields

JiraServerIssueSubtaskFields

JiraServerIssueStatusCategory (Object)

Table 164. JiraServerIssueStatusCategory fields

Value

Type

Description

name

String

None

key

String

None

colorName

String

None

self

String

None

Table 165. Fields where JiraServerIssueStatusCategory is used

Type

Fields

JiraServerIssueStatus

JiraServerIssueSubtask (Object)

Table 166. JiraServerIssueSubtask fields

Value

Type

Description

self

String

None

key

String

None

fields

JiraServerIssueSubtaskFields

None

Table 167. Fields where JiraServerIssueSubtask is used

Type

Fields

JiraServerIssueFields

JiraServerIssueSubtaskFields (Object)

Table 168. JiraServerIssueSubtaskFields fields

Value

Type

Description

summary

String

None

status

JiraServerIssueStatus

None

priority

JiraServerIssuePriority

None

issuetype

JiraServerIssueIssuetype

None

Table 169. Fields where JiraServerIssueSubtaskFields is used

Type

Fields

JiraServerIssueSubtask

JiraServerIssueTimeTracking (Object)

Table 170. JiraServerIssueTimeTracking fields

Value

Type

Description

remainingEstimate

String

None

timeSpent

String

None

remainingEstimateSeconds

Int

None

timeSpentSeconds

Int

None

Table 171. Fields where JiraServerIssueTimeTracking is used

Type

Fields

JiraServerIssueFields

JiraServerIssueVotes (Object)

Table 172. JiraServerIssueVotes fields

Value

Type

Description

self

String

None

votes

Int

None

hasVoted

Boolean

None

Table 173. Fields where JiraServerIssueVotes is used

Type

Fields

JiraServerIssueFields

JiraServerIssueWatches (Object)

Table 174. JiraServerIssueWatches fields

Value

Type

Description

self

String

None

watchCount

Int

None

isWatching

Boolean

None

Table 175. Fields where JiraServerIssueWatches is used

Type

Fields

JiraServerIssueFields

JiraServerUser (Object)

Jira Server User - contains all PII associated with a Jira Server User

Table 176. JiraServerUser fields

Value

Type

Description

key

String

None

jiraUserKey

String

None

name

String

None

displayName

String

None

self

String

None

active

Boolean

None

timeZone

String

None

emailAddress

String

None

avatarUrls

JiraServerUserAvatarUrls

None

JiraServerUserAvatarUrls (Object)

Table 177. JiraServerUserAvatarUrls fields

Value

Type

Description

_16x16

String

None

_32x32

String

None

_48x48

String

None

_24x24

String

None

Table 178. Fields where JiraServerUserAvatarUrls is used

Type

Fields

JiraServerUser

JiraSprint (Object)

Table 179. JiraSprint fields

Value

Type

Description

self

String

None

jiraSprintId

Int

None

state

JiraSprintState

None

name

String

None

startDate

DateTime

None

endDate

DateTime

None

originBoardId

Int

The board from which the sprint was created. Please note that the sprint may still be associated with other boards if those boards contain issues that are in this sprint.

originJiraBoard

JiraBoard

None

goal

String

None

jiraIssueIds

List of String

None

cloudbeesJiraIssueIds

List of String

Synthetic issueId built from clientKey-jiraIssueId for distinguishing issues from different instances

jiraIssues

List of JiraIssue

None

jiraServerIssueIds

List of String

None

cloudbeesJiraServerIssueIds

List of String

Synthetic issueId built from clientKey-jiraIssueId for distinguishing issues from different instances

jiraServerIssues

List of JiraServerIssue

None

policyResults

List of PolicyResult

The results of evaluating policies against this target

JiraSprintState (Enum)

Status associated with a matching result.

Table 180. JiraSprintState enumeration values

Value

Description

active

None

closed

None

future

None

Table 181. Fields where JiraSprintState is used

Type

Fields

JiraSprint

JiraUser (Object)

Jira User - contains all PII associated with a Jira user

Table 182. JiraUser fields

Value

Type

Description

key

String

None

accountId

String

None

displayName

String

None

accountType

String

None

self

String

None

active

Boolean

None

timeZone

String

None

avatarUrls

JiraUserAvatarUrls

None

JiraUserAvatarUrls (Object)

Table 183. JiraUserAvatarUrls fields

Value

Type

Description

_16x16

String

None

_32x32

String

None

_48x48

String

None

_24x24

String

None

Table 184. Fields where JiraUserAvatarUrls is used

Type

Fields

JiraUser

Job (Interface)

Common data model for CI/CD Job

Table 185. Job fields

Value

Type

Description

displayName

String

Display name

url

Url

URL

builds

List of Build

The builds of this job

products

List of Product

Products associated with this job

policyResults

List of PolicyResult

The results of evaluating policies against this target.

Table 186. Types implementing interface Job

Type

Description

JenkinsJob

Jenkins job

Table 187. Fields where Job is used

Type

Fields

Product

Policy (Object)

Policy to evaluate against a target set of entities.

Table 188. Policy fields

Value

Type

Description

name

String

Short display name for policy.

description

String

Short description of policy and purpose.

targetType

String

Data type of the entities in the target set.

targetFilter

String

Query filter determining the target set.

rule

String

Query filter which determines if an entity matches the policy.

results

List of PolicyResult

The results for this policy.

actions

List of PolicyStatusLabelAction

The actions for this policy.

Table 189. Fields where Policy is used

Type

Fields

PolicyResult

PolicyStatusLabelAction

PolicyAction (Interface)

An action associated with a policy.

Table 190. PolicyAction fields

Value

Type

Description

enabled

Boolean

Indicates whether the action is currently enabled.

policy

Policy

The policy the action is associated with.

Table 191. Types implementing interface PolicyAction

Type

Description

PolicyStatusLabelAction

Policy action that provides a label for matching results.

PolicyResult (Object)

Policy result.

Table 192. PolicyResult fields

Value

Type

Description

target

PolicyTarget

The target entity to which the result relates.

policy

Policy

The policy that was evaluated to produce this result.

value

Boolean

True if the entity matches the policy rule.

PolicyResultStatus (Enum)

Status associated with a matching result.

Table 193. PolicyResultStatus enumeration values

Value

Description

ERROR

None

SUCCESS

None

WARNING

None

Table 194. Fields where PolicyResultStatus is used

Type

Fields

PolicyStatusLabelAction

PolicyStatusLabelAction (Object)

Policy action that provides a label for matching results.

Table 195. PolicyStatusLabelAction fields

Value

Type

Description

enabled

Boolean

Indicates whether the action is currently enabled.

policy

Policy

The policy the action is associated with.

label

String

If entity matches the rule, use this label.

status

PolicyResultStatus

If entity matches the rule, use this status.

Table 196. Interfaces implemented by PolicyStatusLabelAction

Type

Description

PolicyAction

An action associated with a policy.

Product (Object)

Table 197. Product fields

Value

Type

Description

name

String

Product name

description

String

Product description

valueStreams

List of ValueStream

Value streams associated with the product

jobs

List of Job

Jobs associated with the product

features

List of Feature

Associated features, added on for two way connection

repositories

List of GithubRepository

GitHub repositories associated with the product

notifiers

List of SlackNotifier

Associated Notifiers, added on for two way connection

PullRequest (Interface)

Pull request interface.

Table 198. PullRequest fields

Value

Type

Description

createdAt

DateTime

When the PR was created.

updatedAt

DateTime

When the PR was last updated.

title

String

The title of the PR.

url

Url

The URL of the PR.

author

RepositoryUser

The person who created the PR.

repository

Repository

The repository the PR belongs to.

reviewRequests

List of PullRequestReviewRequest

The review requests for the PR.

reviews

List of PullRequestReview

The PR reviews.

state

PullRequestState

The state of the PR.

mergeable

PullRequestMergeableState

If PR can be merged.

Table 199. Fields where PullRequest is used

Type

Fields

PullRequestReview

PullRequestReviewRequest

Repository

PullRequestMergeableState (Enum)

The possible mergeable states.

Table 200. PullRequestMergeableState enumeration values

Value

Description

CONFLICTING

If there is a conflict on the PR.

MERGEABLE

If PR can be merged.

Table 201. Fields where PullRequestMergeableState is used

Type

Fields

PullRequest

PullRequestReview (Interface)

A pull request review interface.

Table 202. PullRequestReview fields

Value

Type

Description

author

RepositoryUser

The author of the PR review.

isApproved

Boolean

If the PR is approved.

pullRequest

PullRequest

The PR the review is being left on.

repository

Repository

The repository the PR is linked to.

submittedAt

DateTime

The time the review was submitted at.

Table 203. Fields where PullRequestReview is used

Type

Fields

Repository

PullRequestReviewRequest (Interface)

Pull request review request interface.

Table 204. PullRequestReviewRequest fields

Value

Type

Description

pullRequest

PullRequest

The pull request under review.

requestedReviewer

RepositoryUser

The reviewer for the pull request.

PullRequestState (Enum)

The possible pull request states.

Table 205. PullRequestState enumeration values

Value

Description

CLOSED

If PR is closed.

MERGED

If PR is merged.

OPEN

If PR is open.

Table 206. Fields where PullRequestState is used

Type

Fields

PullRequest

Repository (Interface)

A repository interface.

Table 207. Repository fields

Value

Type

Description

name

String

The name of the repository

nameWithOwner

String

The name of the repository with the owner.

owner

RepositoryUser

The owner of the repository.

updatedAt

DateTime

The last time the repository was updated.

pullRequests

List of PullRequest

The PRs in the repository.

branches

List of Branch

The branches in the repository.

defaultBranch

Branch

The default branch for the repository.

pullRequestReviews

List of PullRequestReview

The PR reviews on the repository.

RepositoryUser (Interface)

Repository user interface.

Table 208. RepositoryUser fields

Value

Type

Description

login

String

The username of the repository user.

Table 209. Fields where RepositoryUser is used

Type

Fields

PullRequest

PullRequestReview

PullRequestReviewRequest

Repository

String (Scalar)

Built-in String

Url (Scalar)

A Url scalar

ValueStream (Object)

Table 210. ValueStream fields

Value

Type

Description

name

String

None

url

String

None

vsId

String

None