YouTrack InCloud 2018.3 Help

JSON Schema

This page contains all of the entities that are supported by YouTrack REST API.

AppearanceSettings

"AppearanceSettings" : { "dateFieldFormat" : "DateFormatDescriptor", "logo" : "Logo", "timeZone" : "TimeZoneDescriptor", "id" : "String" }

BackupError

"BackupError" : { "date" : "Long", "errorMessage" : "String", "id" : "String" }

BackupFile

"BackupFile" : { "creationDate" : "Long", "error" : "String", "id" : "String", "link" : "String", "name" : "String!", "size" : "Long" }

BackupStatus

"BackupStatus" : { "backupCancelled" : "Boolean", "backupError" : "BackupError", "backupInProgress" : "Boolean", "stopBackup" : "Boolean", "id" : "String" }

BuildBundle

"BuildBundle" : { "values" : "MutableCollection", "id" : "String", "isUpdateable" : "Boolean", "name" : "String" }

BuildBundleCustomFieldDefaults

"BuildBundleCustomFieldDefaults" : { "bundle" : "BuildBundle", "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "emptyFieldText" : "String", "id" : "String", "isPublic" : "Boolean", "parent" : "CustomField" }

BuildBundleElement

"BuildBundleElement" : { "assembleDate" : "Long", "bundle" : "BuildBundle", "color" : "FieldStyle", "description" : "String", "hasRunningJob" : "Boolean", "id" : "String", "name" : "String", "ordinal" : "Int" }

BuildProjectCustomField

"BuildProjectCustomField" : { "bundle" : "BuildBundle", "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "defaultValues" : "MutableCollection", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

CheckResult

"CheckResult" : { "date" : "Long", "downloadUrl" : "String", "id" : "String", "message" : "String", "success" : "Boolean", "updateAvailable" : "Boolean" }

CommandLimitedVisibility

"CommandLimitedVisibility" : { "id" : "String", "permittedGroups" : "List", "permittedUsers" : "List" }

CommandList

"CommandList" : { "caret" : "Int", "commands" : "List", "comment" : "String", "issues" : "List", "permittedGroup" : "UserGroup", "query" : "String", "runAs" : "String", "silent" : "Boolean", "suggestions" : "List", "usesMarkdown" : "Boolean", "visibility" : "CommandVisibility", "id" : "String" }

CommandUnlimitedVisibility

"CommandUnlimitedVisibility" : { "id" : "String" }

CustomField

"CustomField" : { "aliases" : "String", "fieldDefaults" : "CustomFieldDefaults", "fieldType" : "FieldType", "hasRunningJob" : "Boolean", "instances" : "MutableCollection", "isAutoAttached" : "Boolean", "isDisplayedInIssueList" : "Boolean", "isUpdateable" : "Boolean", "localizedName" : "String", "name" : "String", "ordinal" : "Int", "id" : "String" }

CustomFieldDefaults

"CustomFieldDefaults" : { "canBeEmpty" : "Boolean", "emptyFieldText" : "String", "isPublic" : "Boolean", "parent" : "CustomField", "id" : "String" }

DatabaseBackupSettings

"DatabaseBackupSettings" : { "archiveFormat" : "BackupFileType", "availableDiskSpace" : "Long", "backupStatus" : "BackupStatus", "cronExpression" : "String", "defaultLocation" : "String", "filesToKeep" : "Int", "isOn" : "Boolean", "location" : "String", "notifiedUsers" : "MutableCollection", "id" : "String" }

DateFormatDescriptor

"DateFormatDescriptor" : { "dateNoYearPattern" : "String", "datePattern" : "String", "id" : "String", "monthPattern" : "String", "pattern" : "String", "presentation" : "String" }

DraftIssueComment

"DraftIssueComment" : { "attachments" : "MutableCollection", "created" : "Long", "id" : "String", "text" : "String", "textPreview" : "String!", "updated" : "Long", "usesMarkdown" : "Boolean", "visibility" : "Visibility" }

DuplicateVote

"DuplicateVote" : { "id" : "String", "issue" : "Issue", "user" : "User" }

EmailSettings

"EmailSettings" : { "from" : "String", "host" : "String", "isEnabled" : "Boolean", "login" : "String", "mailProtocol" : "MailSendProtocol", "port" : "Int", "readAccess" : "Boolean", "sslKey" : "StorageEntry", "id" : "String" }

EnumBundle

"EnumBundle" : { "values" : "MutableCollection", "id" : "String", "isUpdateable" : "Boolean", "name" : "String" }

EnumBundleCustomFieldDefaults

"EnumBundleCustomFieldDefaults" : { "bundle" : "EnumBundle", "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "emptyFieldText" : "String", "id" : "String", "isPublic" : "Boolean", "parent" : "CustomField" }

EnumBundleElement

"EnumBundleElement" : { "bundle" : "EnumBundle", "color" : "FieldStyle", "description" : "String", "hasRunningJob" : "Boolean", "id" : "String", "localizedName" : "String", "name" : "String", "ordinal" : "Int" }

EnumProjectCustomField

"EnumProjectCustomField" : { "bundle" : "EnumBundle", "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "defaultValues" : "MutableCollection", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

ExternalIssue

"ExternalIssue" : { "commentsKey" : "String!", "commentsUrl" : "String!", "historyKey" : "String!", "historyUrl" : "String!", "id" : "String", "key" : "String!", "name" : "String!", "url" : "String!" }

FieldBasedCondition

"FieldBasedCondition" : { "field" : "BundleProjectCustomField", "showForNullValue" : "Boolean", "values" : "MutableCollection", "id" : "String", "parent" : "ProjectCustomField" }

FieldStyle

"FieldStyle" : { "background" : "String", "foreground" : "String", "id" : "String" }

GlobalSettings

"GlobalSettings" : { "appearanceSettings" : "AppearanceSettings", "license" : "License", "limitations" : "Limitations", "localeSettings" : "LocaleSettings", "loggingSettings" : "LoggingSettings", "notificationSettings" : "NotificationSettings", "restSettings" : "RestCorsSettings", "shortcutSettings" : "ShortcutSettings", "systemSettings" : "SystemSettings", "updateInfo" : "UpdateInfo", "id" : "String" }

GroupProjectCustomField

"GroupProjectCustomField" : { "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

Issue

"Issue" : { "attachments" : "MutableCollection", "comments" : "MutableCollection", "created" : "Long", "description" : "String", "draftComment" : "DraftIssueComment", "draftOwner" : "User", "externalIssue" : "ExternalIssue", "fields" : "List", "idReadable" : "String", "isDraft" : "Boolean", "links" : "List", "numberInProject" : "Long", "parent" : "IssueLink", "project" : "Project", "reporter" : "User", "resolved" : "Long", "subtasks" : "IssueLink", "summary" : "String", "tags" : "MutableCollection", "updated" : "Long", "updater" : "User", "usesMarkdown" : "Boolean", "visibility" : "Visibility", "voters" : "IssueVoters", "votes" : "Int", "watchers" : "IssueWatchers", "wikifiedDescription" : "String!", "id" : "String" }

IssueAttachment

"IssueAttachment" : { "author" : "User", "base64Content" : "String", "charset" : "String", "comment" : "BaseIssueComment", "created" : "Long", "draft" : "Boolean", "extension" : "String", "issue" : "Issue", "metaData" : "String", "mimeType" : "String", "name" : "String", "removed" : "Boolean", "size" : "Long", "thumbnailURL" : "String", "updated" : "Long", "url" : "String", "visibility" : "Visibility", "id" : "String" }

IssueComment

"IssueComment" : { "author" : "User", "checkboxes" : "List", "deleted" : "Boolean", "issue" : "Issue", "attachments" : "MutableCollection", "created" : "Long", "id" : "String", "text" : "String", "textPreview" : "String!", "updated" : "Long", "usesMarkdown" : "Boolean", "visibility" : "Visibility" }
"IssueLink" : { "direction" : "LinkDirection", "id" : "String", "issues" : "MutableCollection", "linkType" : "IssueLinkType", "trimmedIssues" : "List" }

IssueLinkType

"IssueLinkType" : { "aggregation" : "Boolean", "directed" : "Boolean", "localizedName" : "String", "localizedSourceToTarget" : "String", "localizedTargetToSource" : "String", "name" : "String", "readOnly" : "Boolean", "sourceToTarget" : "String", "targetToSource" : "String", "uid" : "Long", "id" : "String" }

IssueTag

"IssueTag" : { "color" : "FieldStyle", "issues" : "MutableCollection", "notificationsRules" : "Iterable", "owner" : "User", "untagOnResolve" : "Boolean", "id" : "String", "name" : "String", "updateableBy" : "UserGroup", "visibleFor" : "UserGroup" }

IssueVoters

"IssueVoters" : { "duplicate" : "List", "hasVote" : "Boolean", "original" : "List", "id" : "String" }

IssueWatcher

"IssueWatcher" : { "id" : "String", "isStarred" : "Boolean", "issue" : "Issue", "user" : "User" }

IssueWatchers

"IssueWatchers" : { "duplicateWatchers" : "List", "hasStar" : "Boolean", "id" : "String", "issueWatchers" : "MutableCollection" }

IssueWorkItem

"IssueWorkItem" : { "created" : "Long", "date" : "Long", "duration" : "PeriodValue", "issue" : "Issue", "updated" : "Long", "author" : "User", "creator" : "User", "id" : "String", "text" : "String", "textPreview" : "String!", "type" : "WorkItemType", "usesMarkdown" : "Boolean" }

JabberSettings

"JabberSettings" : { "host" : "String", "isBotEnabled" : "Boolean", "isEnabled" : "Boolean", "login" : "String", "port" : "Int", "readAccess" : "Boolean", "serviceName" : "String", "sslKey" : "StorageEntry", "id" : "String" }

License

"License" : { "enableExpirationWarning" : "Boolean", "error" : "String", "isFreeLicenseUsed" : "Boolean", "isTrialLicenseUsed" : "Boolean", "license" : "String", "licenseCode" : "String", "period" : "String", "prepaid" : "Int", "setupComplete" : "Boolean", "username" : "String", "id" : "String" }

Limitations

"Limitations" : { "timeToExhaustDisk" : "Long", "usableSpace" : "Long", "id" : "String" }

LimitedVisibility

"LimitedVisibility" : { "implicitPermittedUsers" : "List", "permittedGroups" : "MutableCollection", "permittedUsers" : "MutableCollection", "id" : "String" }

LocaleDescriptor

"LocaleDescriptor" : { "community" : "Boolean", "id" : "String", "language" : "String", "locale" : "String", "name" : "String" }

LocaleSettings

"LocaleSettings" : { "isRTL" : "Boolean", "locale" : "LocaleDescriptor", "targetLocale" : "LocaleDescriptor", "id" : "String" }

LoggingSettings

"LoggingSettings" : { "debugCategories" : "Iterable", "id" : "String" }
"Logo" : { "id" : "String", "url" : "String" }

NotificationSettings

"NotificationSettings" : { "emailSettings" : "EmailSettings", "jabberSettings" : "JabberSettings", "restSettings" : "PersistentNotificationsSettings", "id" : "String" }

OnlineUsers

"OnlineUsers" : { "sessions" : "Int", "users" : "Int", "windows" : "Int", "id" : "String" }

OwnedBundle

"OwnedBundle" : { "values" : "MutableCollection", "id" : "String", "isUpdateable" : "Boolean", "name" : "String" }

OwnedBundleCustomFieldDefaults

"OwnedBundleCustomFieldDefaults" : { "bundle" : "OwnedBundle", "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "emptyFieldText" : "String", "id" : "String", "isPublic" : "Boolean", "parent" : "CustomField" }

OwnedBundleElement

"OwnedBundleElement" : { "bundle" : "OwnedBundle", "owner" : "User", "color" : "FieldStyle", "description" : "String", "hasRunningJob" : "Boolean", "id" : "String", "name" : "String", "ordinal" : "Int" }

OwnedProjectCustomField

"OwnedProjectCustomField" : { "bundle" : "OwnedBundle", "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "defaultValues" : "MutableCollection", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

ParsedCommand

"ParsedCommand" : { "delete" : "Boolean", "description" : "String", "error" : "Boolean", "id" : "String" }

PeriodProjectCustomField

"PeriodProjectCustomField" : { "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

Project

"Project" : { "archived" : "Boolean", "createdBy" : "User", "description" : "String", "fields" : "MutableCollection", "fromEmail" : "String", "hubResourceId" : "String!", "iconUrl" : "String!", "issues" : "MutableCollection", "leader" : "User", "ringId" : "String", "shortName" : "String", "startingNumber" : "Long", "id" : "String", "name" : "String" }

ProjectCustomField

"ProjectCustomField" : { "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project", "id" : "String" }

ProjectTimeTrackingSettings

"ProjectTimeTrackingSettings" : { "enabled" : "Boolean", "estimate" : "ProjectCustomField", "project" : "Project", "timeSpent" : "ProjectCustomField", "workItemTypes" : "MutableCollection", "id" : "String" }

RestCorsSettings

"RestCorsSettings" : { "allowAllOrigins" : "Boolean", "allowedOrigins" : "Collection", "id" : "String" }

ShortcutSettings

"ShortcutSettings" : { "serverShortcuts" : "String", "shortcuts" : "List", "id" : "String" }

SimpleProjectCustomField

"SimpleProjectCustomField" : { "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

StateBundle

"StateBundle" : { "values" : "MutableCollection", "id" : "String", "isUpdateable" : "Boolean", "name" : "String" }

StateBundleCustomFieldDefaults

"StateBundleCustomFieldDefaults" : { "bundle" : "StateBundle", "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "emptyFieldText" : "String", "id" : "String", "isPublic" : "Boolean", "parent" : "CustomField" }

StateBundleElement

"StateBundleElement" : { "bundle" : "StateBundle", "isResolved" : "Boolean", "color" : "FieldStyle", "description" : "String", "hasRunningJob" : "Boolean", "id" : "String", "localizedName" : "String", "name" : "String", "ordinal" : "Int" }

StateProjectCustomField

"StateProjectCustomField" : { "bundle" : "StateBundle", "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "defaultValues" : "MutableCollection", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

StorageEntry

"StorageEntry" : { "name" : "String", "id" : "String" }

Suggestion

"Suggestion" : { "auxiliaryIcon" : "String", "caret" : "Int", "className" : "String", "completionEnd" : "Int", "completionStart" : "Int", "description" : "String", "group" : "String", "icon" : "String", "id" : "String", "matchingEnd" : "Int", "matchingStart" : "Int", "option" : "String", "prefix" : "String", "suffix" : "String" }

SystemSettings

"SystemSettings" : { "administratorEmail" : "String", "allowStatisticsCollection" : "Boolean", "baseUrl" : "String", "isApplicationReadOnly" : "Boolean", "maxExportItems" : "Int", "maxOrderedIssues" : "Int", "maxUploadFileSize" : "Long", "id" : "String" }

Telemetry

"Telemetry" : { "allocatedMemory" : "String", "availableMemory" : "String", "availableProcessors" : "Int", "blobStringsCacheHitRate" : "String", "cachedResultsCountInDBQueriesCache" : "Int", "databaseBackgroundThreads" : "Int", "databaseLocation" : "String", "databaseQueriesCacheHitRate" : "String", "databaseSize" : "String", "fullDatabaseSize" : "String", "installationFolder" : "String", "jobs" : "Jobs", "logsLocation" : "String", "onlineUsers" : "OnlineUsers", "pendingAsyncJobs" : "Int", "requestsPerSecond" : "String", "startedTime" : "Long", "textIndexSize" : "String", "totalTransactions" : "Long", "transactionsPerSecond" : "String", "uptime" : "String", "usedMemory" : "String", "id" : "String" }

TextIndexSettings

"TextIndexSettings" : { "documentsToIndex" : "Int", "indexingInProgress" : "Boolean", "languages" : "Collection", "suspended" : "Boolean", "id" : "String" }

TextProjectCustomField

"TextProjectCustomField" : { "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

TimeTrackingSettings

"TimeTrackingSettings" : { "workItemTypes" : "MutableList", "workTimeSettings" : "WorkTimeSettings", "id" : "String" }

TimeZoneDescriptor

"TimeZoneDescriptor" : { "id" : "String", "offset" : "Int", "presentation" : "String" }

UnlimitedVisibility

"UnlimitedVisibility" : { "id" : "String" }

UpdateInfo

"UpdateInfo" : { "isChecking" : "Boolean", "result" : "CheckResult", "id" : "String" }

User

"User" : { "avatarUrl" : "String", "banned" : "Boolean", "email" : "String", "fullName" : "String", "guest" : "Boolean", "jabberAccountName" : "String", "login" : "String", "name" : "String", "online" : "Boolean", "profiles" : "UserProfiles", "ringId" : "String", "tags" : "MutableCollection", "id" : "String" }

UserBundle

"UserBundle" : { "aggregatedUsers" : "List", "groups" : "MutableCollection", "individuals" : "MutableCollection", "id" : "String", "isUpdateable" : "Boolean", "name" : "String" }

UserCustomFieldDefaults

"UserCustomFieldDefaults" : { "bundle" : "UserBundle", "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "emptyFieldText" : "String", "id" : "String", "isPublic" : "Boolean", "parent" : "CustomField" }

UserGroup

"UserGroup" : { "allUsersGroup" : "Boolean", "icon" : "String", "name" : "String", "ringId" : "String!", "teamForProject" : "Project", "usersCount" : "Long", "id" : "String" }

UserProjectCustomField

"UserProjectCustomField" : { "bundle" : "UserBundle", "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

VersionBundle

"VersionBundle" : { "values" : "MutableCollection", "id" : "String", "isUpdateable" : "Boolean", "name" : "String" }

VersionBundleCustomFieldDefaults

"VersionBundleCustomFieldDefaults" : { "bundle" : "VersionBundle", "defaultValues" : "MutableCollection", "canBeEmpty" : "Boolean", "emptyFieldText" : "String", "id" : "String", "isPublic" : "Boolean", "parent" : "CustomField" }

VersionBundleElement

"VersionBundleElement" : { "archived" : "Boolean", "bundle" : "VersionBundle", "releaseDate" : "Long", "released" : "Boolean", "color" : "FieldStyle", "description" : "String", "hasRunningJob" : "Boolean", "id" : "String", "name" : "String", "ordinal" : "Int" }

VersionProjectCustomField

"VersionProjectCustomField" : { "bundle" : "VersionBundle", "canBeEmpty" : "Boolean", "condition" : "CustomFieldCondition", "defaultValues" : "MutableCollection", "emptyFieldText" : "String", "field" : "CustomField", "hasRunningJob" : "Boolean", "id" : "String", "isPublic" : "Boolean", "ordinal" : "Int", "project" : "Project" }

Visibility

"Visibility" : { "id" : "String" }

WorkItemType

"WorkItemType" : { "autoAttached" : "Boolean", "name" : "String", "id" : "String" }

WorkTimeSettings

"WorkTimeSettings" : { "daysAWeek" : "Int", "firstDayOfWeek" : "Int", "minutesADay" : "Int", "workDays" : "List", "id" : "String" }
Last modified: 12 October 2018