GetProject | /src/version2/parameters/getProject.ts | jira@v3.0.2

Module

x/jira/src/version2/parameters/getProject.ts>GetProject

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API

MrRefactoring/jira.js

Latest

index.ts (default module)

addFieldToDefaultScreen.ts

AddFieldToDefaultScreen

addGadget.ts

addIssueTypesToContext.ts

addIssueTypesToIssueTypeScheme.ts

addProjectRoleActorsToRole.ts

addScreenTab.ts

addScreenTabField.ts

addSecurityLevel.ts

addSecurityLevelMembers.ts

addSharePermission.ts

appendMappingsForIssueTypeScreenScheme.ts

archiveIssues.ts

ArchiveIssues

archiveIssuesAsync.ts

ArchiveIssuesAsync

archiveProject.ts

ArchiveProject

assignFieldConfigurationSchemeToProject.ts

assignIssue.ts

assignIssueTypeSchemeToProject.ts

assignIssueTypeScreenSchemeToProject.ts

assignPermissionScheme.ts

assignProjectsToCustomFieldContext.ts

assignSchemeToProject.ts

associateSchemesToProjects.ts

bulkDeleteIssueProperty.ts

bulkEditDashboards.ts

bulkGetUsersMigration.ts

BulkGetUsersMigration

bulkSetIssuePropertiesByIssue.ts

bulkSetIssueProperty.ts

bulkSetIssuesProperties.ts

createCustomFieldContext.ts

CreateCustomFieldContext

createCustomFieldOption.ts

createDashboard.ts

createFieldConfiguration.ts

createFieldConfigurationScheme.ts

createFilter.ts

createGroup.ts

createIssue.ts

createIssueFieldOption.ts

createIssueLinkType.ts

createIssues.ts

createIssueSecurityScheme.ts

createIssueType.ts

createIssueTypeAvatar.ts

CreateIssueTypeAvatar

createIssueTypeScheme.ts

createIssueTypeScreenScheme.ts

createNotificationScheme.ts

createOrUpdateRemoteIssueLink.ts

createPermissionGrant.ts

createPermissionScheme.ts

createPriority.ts

createProject.ts

createProjectAvatar.ts

CreateProjectAvatar

createProjectCategory.ts

createProjectRole.ts

createResolution.ts

createScreen.ts

createScreenScheme.ts

createStatuses.ts

createUiModification.ts

createWorkflowScheme.ts

createWorkflowSchemeDraftFromParent.ts

CreateWorkflowSchemeDraftFromParent

createWorkflowTransitionProperty.ts

deleteActor.ts

DeleteActor

deleteAddonProperty.ts

DeleteAddonProperty

deleteAndReplaceVersion.ts

deleteCommentProperty.ts

DeleteCommentProperty

deleteCustomFieldContext.ts

DeleteCustomFieldContext

deleteCustomFieldOption.ts

DeleteCustomFieldOption

deleteDashboard.ts

DeleteDashboard

deleteDashboardItemProperty.ts

DeleteDashboardItemProperty

deleteDefaultWorkflow.ts

DeleteDefaultWorkflow

deleteDraftDefaultWorkflow.ts

DeleteDraftDefaultWorkflow

deleteDraftWorkflowMapping.ts

DeleteDraftWorkflowMapping

deleteFavouriteForFilter.ts

DeleteFavouriteForFilter

deleteFieldConfiguration.ts

DeleteFieldConfiguration

deleteFieldConfigurationScheme.ts

DeleteFieldConfigurationScheme

deleteFilter.ts

DeleteFilter

deleteInactiveWorkflow.ts

DeleteInactiveWorkflow

deleteIssue.ts

DeleteIssue

deleteIssueFieldOption.ts

DeleteIssueFieldOption

deleteIssueLink.ts

DeleteIssueLink

deleteIssueLinkType.ts

DeleteIssueLinkType

deleteIssueProperty.ts

DeleteIssueProperty

deleteIssueType.ts

DeleteIssueType

deleteIssueTypeProperty.ts

DeleteIssueTypeProperty

deleteIssueTypeScheme.ts

DeleteIssueTypeScheme

deleteIssueTypeScreenScheme.ts

DeleteIssueTypeScreenScheme

deleteNotificationScheme.ts

DeleteNotificationScheme

deletePermissionScheme.ts

DeletePermissionScheme

deletePermissionSchemeEntity.ts

DeletePermissionSchemeEntity

deleteProject.ts

DeleteProject

deleteProjectAsynchronously.ts

DeleteProjectAsynchronously

deleteProjectAvatar.ts

DeleteProjectAvatar

deleteProjectProperty.ts

DeleteProjectProperty

deleteProjectRole.ts

DeleteProjectRole

deleteProjectRoleActorsFromRole.ts

DeleteProjectRoleActorsFromRole

deleteRemoteIssueLinkByGlobalId.ts

DeleteRemoteIssueLinkByGlobalId

deleteRemoteIssueLinkById.ts

DeleteRemoteIssueLinkById

deleteScreenScheme.ts

DeleteScreenScheme

deleteScreenTab.ts

DeleteScreenTab

deleteSecurityScheme.ts

DeleteSecurityScheme

deleteSharePermission.ts

DeleteSharePermission

deleteStatusesById.ts

DeleteStatusesById

deleteUiModification.ts

DeleteUiModification

deleteUserProperty.ts

DeleteUserProperty

deleteWebhookById.ts

deleteWorkflowMapping.ts

DeleteWorkflowMapping

deleteWorkflowScheme.ts

DeleteWorkflowScheme

deleteWorkflowSchemeDraft.ts

DeleteWorkflowSchemeDraft

deleteWorkflowSchemeDraftIssueType.ts

DeleteWorkflowSchemeDraftIssueType

deleteWorkflowSchemeIssueType.ts

DeleteWorkflowSchemeIssueType

deleteWorkflowTransitionProperty.ts

DeleteWorkflowTransitionProperty

deleteWorkflowTransitionRuleConfigurations.ts

deleteWorklog.ts

DeleteWorklog

deleteWorklogProperty.ts

DeleteWorklogProperty

doTransition.ts

editIssue.ts

evaluateJiraExpression.ts

expandAttachmentForHumans.ts

ExpandAttachmentForHumans

expandAttachmentForMachines.ts

ExpandAttachmentForMachines

exportArchivedIssues.ts

findAssignableUsers.ts

FindAssignableUsers

findBulkAssignableUsers.ts

FindBulkAssignableUsers

findGroups.ts

FindGroups

findUserKeysByQuery.ts

FindUserKeysByQuery

findUsers.ts

FindUsers

findUsersAndGroups.ts

FindUsersAndGroups

findUsersByQuery.ts

FindUsersByQuery

findUsersForPicker.ts

FindUsersForPicker

findUsersWithAllPermissions.ts

FindUsersWithAllPermissions

findUsersWithBrowsePermission.ts

FindUsersWithBrowsePermission

fullyUpdateProjectRole.ts

getAccessibleProjectTypeByKey.ts

GetAccessibleProjectTypeByKey

getAddonProperties.ts

getAllFieldConfigurations.ts

GetAllFieldConfigurations

getAllFieldConfigurationSchemes.ts

GetAllFieldConfigurationSchemes

getAllGadgets.ts

GetAllGadgets

getAllIssueFieldOptions.ts

GetAllIssueFieldOptions

getAllIssueTypeSchemes.ts

GetAllIssueTypeSchemes

getAllLabels.ts

GetAllLabels

getAllPermissionSchemes.ts

GetAllPermissionSchemes

getAllProjectAvatars.ts

GetAllProjectAvatars

getAllScreenTabFields.ts

GetAllScreenTabFields

getAllSystemAvatars.ts

GetAllSystemAvatars

getAllUsers.ts

GetAllUsers

getAllUsersDefault.ts

GetAllUsersDefault

getAllWorkflowSchemes.ts

GetAllWorkflowSchemes

getAlternativeIssueTypes.ts

GetAlternativeIssueTypes

getApplicationProperty.ts

GetApplicationProperty

getApplicationRole.ts

GetApplicationRole

getAssignedPermissionScheme.ts

GetAssignedPermissionScheme

getAttachment.ts

GetAttachment

getAttachmentContent.ts

GetAttachmentContent

getAttachmentThumbnail.ts

GetAttachmentThumbnail

getAuditRecords.ts

GetAuditRecords

getAutoCompletePost.ts

getAvailableScreenFields.ts

GetAvailableScreenFields

getAvatarImageByID.ts

GetAvatarImageByID

getAvatarImageByOwner.ts

GetAvatarImageByOwner

getAvatarImageByType.ts

GetAvatarImageByType

getAvatars.ts

GetAvatars

getBulkPermissions.ts

getChangeLogs.ts

GetChangeLogs

getChangeLogsByIds.ts

getCommentProperty.ts

GetCommentProperty

getCommentPropertyKeys.ts

GetCommentPropertyKeys

getComponentRelatedIssues.ts

GetComponentRelatedIssues

getContextsForField.ts

GetContextsForField

getCreateIssueMeta.ts

GetCreateIssueMeta

getCurrentUser.ts

GetCurrentUser

getCustomFieldConfiguration.ts

GetCustomFieldConfiguration

getCustomFieldContextsForProjectsAndIssueTypes.ts

getCustomFieldOption.ts

GetCustomFieldOption

getDashboard.ts

GetDashboard

getDashboardItemProperty.ts

GetDashboardItemProperty

getDashboardItemPropertyKeys.ts

GetDashboardItemPropertyKeys

getDashboardsPaginated.ts

GetDashboardsPaginated

getDefaultValues.ts

GetDefaultValues

getDefaultWorkflow.ts

GetDefaultWorkflow

getDraftDefaultWorkflow.ts

GetDraftDefaultWorkflow

getDraftWorkflow.ts

GetDraftWorkflow

getDynamicWebhooksForApp.ts

GetDynamicWebhooksForApp

getFavouriteFilters.ts

GetFavouriteFilters

getFeaturesForProject.ts

GetFeaturesForProject

getFieldAutoCompleteForQueryString.ts

GetFieldAutoCompleteForQueryString

getFieldConfigurationItems.ts

GetFieldConfigurationItems

getFieldConfigurationSchemeMappings.ts

GetFieldConfigurationSchemeMappings

getFieldConfigurationSchemeProjectMapping.ts

GetFieldConfigurationSchemeProjectMapping

getFieldsPaginated.ts

GetFieldsPaginated

getFilter.ts

GetFilter

getFiltersPaginated.ts

GetFiltersPaginated

getHierarchy.ts

GetHierarchy

getIdsOfWorklogsDeletedSince.ts

GetIdsOfWorklogsDeletedSince

getIdsOfWorklogsModifiedSince.ts

GetIdsOfWorklogsModifiedSince

getIssue.ts

GetIssue

getIssueFieldOption.ts

getIssuePickerResource.ts

GetIssuePickerResource

getIssueProperty.ts

GetIssueProperty

getIssuePropertyKeys.ts

GetIssuePropertyKeys

getIssueSecurityLevel.ts

GetIssueSecurityLevel

getIssueSecurityLevelMembers.ts

GetIssueSecurityLevelMembers

getIssueSecurityScheme.ts

GetIssueSecurityScheme

getIssueType.ts

GetIssueType

getIssueTypeMappingsForContexts.ts

GetIssueTypeMappingsForContexts

getIssueTypeProperty.ts

GetIssueTypeProperty

getIssueTypePropertyKeys.ts

GetIssueTypePropertyKeys

getIssueTypeSchemeForProjects.ts

GetIssueTypeSchemeForProjects

getIssueTypeSchemesMapping.ts

GetIssueTypeSchemesMapping

getIssueTypeScreenSchemeMappings.ts

GetIssueTypeScreenSchemeMappings

getIssueTypeScreenSchemeProjectAssociations.ts

GetIssueTypeScreenSchemeProjectAssociations

getIssueTypeScreenSchemes.ts

GetIssueTypeScreenSchemes

getIssueTypesForProject.ts

GetIssueTypesForProject

getIsWatchingIssueBulk.ts

getNotificationScheme.ts

GetNotificationScheme

getNotificationSchemeForProject.ts

GetNotificationSchemeForProject

getNotificationSchemes.ts

GetNotificationSchemes

getNotificationSchemeToProjectMappings.ts

GetNotificationSchemeToProjectMappings

getOptionsForContext.ts

GetOptionsForContext

getPermissionScheme.ts

GetPermissionScheme

getPermissionSchemeGrant.ts

GetPermissionSchemeGrant

getPermissionSchemeGrants.ts

GetPermissionSchemeGrants

getPermittedProjects.ts

getPrecomputations.ts

getProjectCategoryById.ts

GetProjectCategoryById

getProjectComponents.ts

GetProjectComponents

getProjectComponentsPaginated.ts

GetProjectComponentsPaginated

getProjectContextMapping.ts

GetProjectContextMapping

getProjectEmail.ts

GetProjectEmail

getProjectIssueSecurityScheme.ts

GetProjectIssueSecurityScheme

getProjectProperty.ts

GetProjectProperty

getProjectPropertyKeys.ts

GetProjectPropertyKeys

getProjectRole.ts

GetProjectRole

getProjectRoleActorsForRole.ts

GetProjectRoleActorsForRole

getProjectRoleById.ts

GetProjectRoleById

getProjectRoleDetails.ts

GetProjectRoleDetails

getProjectRoles.ts

GetProjectRoles

getProjectsForIssueTypeScreenScheme.ts

GetProjectsForIssueTypeScreenScheme

getProjectTypeByKey.ts

GetProjectTypeByKey

getProjectVersions.ts

GetProjectVersions

getProjectVersionsPaginated.ts

GetProjectVersionsPaginated

getRecent.ts

GetRecent

getRemoteIssueLinkById.ts

GetRemoteIssueLinkById

getRemoteIssueLinks.ts

getScreensForField.ts

GetScreensForField

getSecurityLevelMembers.ts

GetSecurityLevelMembers

getSecurityLevels.ts

GetSecurityLevels

getSecurityLevelsForProject.ts

GetSecurityLevelsForProject

getSelectableIssueFieldOptions.ts

GetSelectableIssueFieldOptions

getSharePermission.ts

GetSharePermission

getSharePermissions.ts

getTrashedFieldsPaginated.ts

GetTrashedFieldsPaginated

getUiModifications.ts

GetUiModifications

getUser.ts

GetUser

getUserDefaultColumns.ts

GetUserDefaultColumns

getUserPropertyKeys.ts

GetUserPropertyKeys

getUsersFromGroup.ts

GetUsersFromGroup

getValidProjectKey.ts

GetValidProjectKey

getValidProjectName.ts

GetValidProjectName

getVersion.ts

GetVersion

getVersionRelatedIssues.ts

GetVersionRelatedIssues

getVersionUnresolvedIssues.ts

GetVersionUnresolvedIssues

getVisibleIssueFieldOptions.ts

GetVisibleIssueFieldOptions

getWorkflowSchemeDraft.ts

GetWorkflowSchemeDraft

getWorkflowSchemeDraftIssueType.ts

GetWorkflowSchemeDraftIssueType

getWorkflowSchemeIssueType.ts

GetWorkflowSchemeIssueType

getWorkflowSchemeProjectAssociations.ts

GetWorkflowSchemeProjectAssociations

getWorkflowsPaginated.ts

GetWorkflowsPaginated

getWorkflowTransitionProperties.ts

GetWorkflowTransitionProperties

getWorkflowTransitionRuleConfigurations.ts

GetWorkflowTransitionRuleConfigurations

getWorklog.ts

GetWorklog

getWorklogProperty.ts

GetWorklogProperty

getWorklogPropertyKeys.ts

GetWorklogPropertyKeys

moveScreenTabField.ts

moveVersion.ts

notify.ts

parseJqlQueries.ts

partialUpdateProjectRole.ts

publishDraftWorkflowScheme.ts

registerDynamicWebhooks.ts

registerModules.ts

removeAttachment.ts

RemoveAttachment

removeCustomFieldContextFromProjects.ts

removeIssueTypeFromIssueTypeScheme.ts

RemoveIssueTypeFromIssueTypeScheme

removeIssueTypesFromContext.ts

removeIssueTypesFromGlobalFieldConfigurationScheme.ts

removeLevel.ts

RemoveLevel

removeMappingsFromIssueTypeScreenScheme.ts

removeMemberFromSecurityLevel.ts

RemoveMemberFromSecurityLevel

removeModules.ts

RemoveModules

removeNotificationFromNotificationScheme.ts

RemoveNotificationFromNotificationScheme

removePreference.ts

RemovePreference

removeProjectCategory.ts

RemoveProjectCategory

removeScreenTabField.ts

RemoveScreenTabField

removeUser.ts

RemoveUser

removeUserFromGroup.ts

reorderCustomFieldOptions.ts

reorderIssueTypesInIssueTypeScheme.ts

replaceIssueFieldOption.ts

ReplaceIssueFieldOption

restoreCustomField.ts

RestoreCustomField

sanitiseJqlQueries.ts

search.ts

searchForIssuesUsingJql.ts

SearchForIssuesUsingJql

searchForIssuesUsingJqlPost.ts

searchProjectsUsingSecuritySchemes.ts

SearchProjectsUsingSecuritySchemes

searchResolutions.ts

SearchResolutions

searchSecuritySchemes.ts

SearchSecuritySchemes

selectTimeTrackingImplementation.ts

setActors.ts

setApplicationProperty.ts

setBanner.ts

setColumns.ts

SetColumns

setCommentProperty.ts

SetCommentProperty

setDashboardItemProperty.ts

SetDashboardItemProperty

setDefaultLevels.ts

setDefaultPriority.ts

setDefaultResolution.ts

setDefaultShareScope.ts

setDefaultValues.ts

setFavouriteForFilter.ts

SetFavouriteForFilter

setFieldConfigurationSchemeMapping.ts

setIssueProperty.ts

SetIssueProperty

setIssueTypeProperty.ts

SetIssueTypeProperty

setPreference.ts

SetPreference

setProjectProperty.ts

SetProjectProperty

setSharedTimeTrackingConfiguration.ts

setWorkflowSchemeDraftIssueType.ts

setWorkflowSchemeIssueType.ts

setWorklogProperty.ts

SetWorklogProperty

storeAvatar.ts

StoreAvatar

toggleFeatureForProject.ts

updateCustomFieldConfiguration.ts

updateCustomFieldContext.ts

updateCustomFieldOption.ts

updateCustomFieldValue.ts

updateDashboard.ts

updateDefaultScreenScheme.ts

UpdateDefaultScreenScheme

updateDefaultWorkflow.ts

updateDraftDefaultWorkflow.ts

updateDraftWorkflowMapping.ts

updateEntityPropertiesValue.ts

updateFieldConfiguration.ts

updateFieldConfigurationItems.ts

updateFieldConfigurationScheme.ts

updateFilter.ts

updateGadget.ts

updateIssueFieldOption.ts

updateIssueFields.ts

updateIssueLinkType.ts

updateIssueSecurityScheme.ts

updateIssueType.ts

updateIssueTypeScheme.ts

updateIssueTypeScreenScheme.ts

updateMultipleCustomFieldValues.ts

updateNotificationScheme.ts

updatePermissionScheme.ts

updatePrecomputations.ts

updatePriority.ts

updateProject.ts

updateProjectAvatar.ts

updateProjectCategory.ts

updateProjectEmail.ts

updateRemoteIssueLink.ts

updateResolution.ts

updateScreen.ts

updateScreenScheme.ts

updateSecurityLevel.ts

updateStatuses.ts

updateUiModification.ts

updateVersion.ts

updateWorkflowMapping.ts

updateWorkflows.ts

updateWorkflowScheme.ts

updateWorkflowSchemeDraft.ts

updateWorkflowTransitionProperty.ts

updateWorkflowTransitionRuleConfigurations.ts

updateWorklog.ts

validateCreateWorkflows.ts

validateProjectKey.ts

ValidateProjectKey

validateUpdateWorkflows.ts

workflowCapabilities.ts

WorkflowCapabilities

workflowRuleSearch.ts

interface GetProject

import { type GetProject } from "https://deno.land/x/jira@v3.0.2/src/version2/parameters/getProject.ts";

Properties

projectIdOrKey: string | number

The project ID or project key (case-sensitive).

optional

expand:

| "description"

| "issueTypes"

| "lead"

| "projectKeys"

| "issueTypeHierarchy"

| (

| "description"

| "issueTypes"

| "lead"

| "projectKeys"

| "issueTypeHierarchy"

)[]

| string

| string[]

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:

description The project description.
issueTypes The issue types associated with the project.
lead The project lead.
projectKeys All project keys associated with the project.
issueTypeHierarchy The project issue type hierarchy.

optional

properties: string[]

A list of project properties to return for the project. This parameter accepts a comma-separated list.