WorkItemTrackingRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
생성자
| Work |
속성
| RESOURCE_AREA_ID |
메서드
생성자 세부 정보
WorkItemTrackingRestClient(IVssRestClientOptions)
속성 세부 정보
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string속성 값
string
메서드 세부 정보
createAttachment(any, string, string, string, string)
첨부 파일을 업로드합니다.
function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>매개 변수
- content
-
any
업로드할 콘텐츠
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fileName
-
string
파일 이름입니다.
- uploadType
-
string
첨부 파일 업로드 유형: 단순 또는 청크
- areaPath
-
string
대상 프로젝트 영역 경로
반환
Promise<AttachmentReference>
createField(WorkItemField, string)
새 필드를 만듭니다.
function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>매개 변수
- workItemField
- WorkItemField
새 필드 정의
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemField>
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)
새로 만들거나 기존 분류 노드를 업데이트합니다.
function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>매개 변수
- postedNode
- WorkItemClassificationNode
만들거나 업데이트할 노드입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- structureGroup
- TreeStructureGroup
분류 노드, 영역 또는 반복의 구조 그룹입니다.
- path
-
string
분류 노드의 경로입니다.
반환
Promise<WorkItemClassificationNode>
createQuery(QueryHierarchyItem, string, string, boolean)
쿼리를 만들거나 쿼리를 이동합니다.
function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>매개 변수
- postedQuery
- QueryHierarchyItem
만들 쿼리입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- query
-
string
쿼리를 만들 부모 ID 또는 경로입니다.
- validateWiqlOnly
-
boolean
실제로 쿼리를 만들지 않고 WIQL 쿼리의 유효성을 검사하려는 경우 true로 설정합니다. 기본값은 false입니다.
반환
Promise<QueryHierarchyItem>
createTemplate(WorkItemTemplate, string, string)
템플릿 만들기
function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>매개 변수
- template
- WorkItemTemplate
템플릿 내용
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
반환
Promise<WorkItemTemplate>
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)
단일 작업 항목을 만듭니다.
function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>매개 변수
- document
- JsonPatchDocument
작업 항목을 나타내는 JSON 패치 문서
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- type
-
string
만들 작업 항목의 작업 항목 유형
- validateOnly
-
boolean
작업 항목을 저장하지 않고 변경 내용의 유효성을 검사할 것인지 여부를 나타냅니다.
- bypassRules
-
boolean
이 업데이트에 작업 항목 유형 규칙을 적용하지 마세요.
- suppressNotifications
-
boolean
이 변경에 대한 알림을 실행하지 마세요.
- expand
- WorkItemExpand
작업 항목 특성에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Relations, Fields, Links, All }입니다.
반환
Promise<WorkItem>
deleteClassificationNode(string, TreeStructureGroup, string, number)
기존 분류 노드를 삭제합니다.
function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- structureGroup
- TreeStructureGroup
분류 노드, 영역 또는 반복의 구조 그룹입니다.
- path
-
string
분류 노드의 경로입니다.
- reclassifyId
-
number
재분류를 위한 대상 분류 노드의 ID입니다.
반환
Promise<void>
deleteField(string, string)
필드를 삭제합니다. 파일 삭제를 취소하려면 "필드 업데이트" API를 참조하세요.
function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>매개 변수
- fieldNameOrRefName
-
string
필드 단순 이름 또는 참조 이름
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<void>
deleteQuery(string, string)
쿼리 또는 폴더를 삭제합니다. 이렇게 하면 삭제된 쿼리 또는 폴더에 대한 사용 권한 변경 내용과 폴더인 경우 해당 하위 항목이 삭제됩니다. 삭제된 권한 변경 내용은 쿼리 또는 폴더를 삭제할 때 복구할 수 없습니다.
function deleteQuery(project: string, query: string): Promise<void>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- query
-
string
삭제할 쿼리 또는 폴더의 ID 또는 경로입니다.
반환
Promise<void>
deleteTemplate(string, string, string)
지정된 ID를 사용하여 템플릿을 삭제합니다.
function deleteTemplate(project: string, team: string, templateId: string): Promise<void>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
- templateId
-
string
템플릿 ID
반환
Promise<void>
deleteWorkItem(number, string, boolean)
지정된 작업 항목을 삭제하고 휴지통으로 보내 필요한 경우 다시 복원할 수 있습니다. 필요에 따라 destroy 매개 변수가 true로 설정된 경우 작업 항목을 영구적으로 삭제합니다. 경고: destroy 매개 변수가 true로 설정된 경우 이 명령으로 삭제된 작업 항목은 휴지통으로 이동하지 않으며 삭제 후 복원/복구할 방법이 없습니다. 이 매개 변수를 사용하지 않는 것이 좋습니다. 이렇게 하는 경우 이 매개 변수를 주의해서 사용하세요.
function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>매개 변수
- id
-
number
삭제할 작업 항목의 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- destroy
-
boolean
선택적 매개 변수인 true로 설정하면 작업 항목이 영구적으로 삭제됩니다. 참고: 삭제 작업은 영구이며 실행 취소할 수 없습니다.
반환
Promise<WorkItemDelete>
destroyWorkItem(number, string)
휴지통에서 지정된 작업 항목을 영구적으로 삭제합니다. 이 작업은 실행 취소할 수 없습니다.
function destroyWorkItem(id: number, project?: string): Promise<void>매개 변수
- id
-
number
영구적으로 삭제할 작업 항목의 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<void>
exportWorkItemTypeDefinition(string, string, boolean)
작업 항목 유형 내보내기
function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- type
-
string
- exportGlobalLists
-
boolean
반환
Promise<WorkItemTypeTemplate>
getAccountMyWorkData(QueryOption)
내부 전용: 계정 내 작업 페이지에서 사용됩니다. 그러면 작업, 완료, 팔로우 및 작업 작업 항목 세부 정보가 반환됩니다.
function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>매개 변수
- queryOption
- QueryOption
반환
Promise<AccountMyWorkResult>
getAttachmentContent(string, string, string, boolean)
첨부 파일을 다운로드합니다.
function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>매개 변수
- id
-
string
첨부 파일 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fileName
-
string
파일의 이름입니다.
- download
-
boolean
c true</c>>로 <설정된 경우 항상 첨부 파일 다운로드
반환
Promise<ArrayBuffer>
getAttachmentZip(string, string, string, boolean)
첨부 파일을 다운로드합니다.
function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>매개 변수
- id
-
string
첨부 파일 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fileName
-
string
파일의 이름입니다.
- download
-
boolean
c true</c>>로 <설정된 경우 항상 첨부 파일 다운로드
반환
Promise<ArrayBuffer>
getClassificationNode(string, TreeStructureGroup, string, number)
지정된 노드 경로에 대한 분류 노드를 가져옵니다.
function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- structureGroup
- TreeStructureGroup
분류 노드, 영역 또는 반복의 구조 그룹입니다.
- path
-
string
분류 노드의 경로입니다.
- depth
-
number
가져올 자식의 깊이입니다.
반환
Promise<WorkItemClassificationNode>
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)
지정된 프로젝트의 지정된 노드 ID 목록에 대한 루트 분류 노드 또는 분류 노드 목록을 가져옵니다. ids 매개 변수가 제공되는 경우 해당 ID에 대한 분류 노드 목록을 가져옵니다. 그렇지 않으면 이 프로젝트에 대한 루트 분류 노드가 표시됩니다.
function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- ids
-
number[]
쉼표로 구분된 정수 분류 노드 ID입니다. 루트 노드를 원하는 경우 필요하지 않습니다.
- depth
-
number
가져올 자식의 깊이입니다.
- errorPolicy
- ClassificationNodesErrorPolicy
일부 노드 가져오기에서 오류를 처리하는 플래그입니다. 가능한 옵션은 실패 및 생략입니다.
반환
Promise<WorkItemClassificationNode[]>
getComment(number, number, string)
지정된 수정 버전에서 작업 항목에 대한 주석을 가져옵니다.
function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>매개 변수
- id
-
number
작업 항목 ID
- revision
-
number
주석을 가져와야 하는 수정 버전
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemComment>
getComments(number, string, number, number, CommentSortOrder)
지정된 수정 버전에서 작업 항목에 대해 지정된 주석 수를 가져옵니다.
function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>매개 변수
- id
-
number
작업 항목 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fromRevision
-
number
주석을 가져올 수정 버전(기본값: 1)
- top
-
number
반환할 주석 수(기본값: 200)
- order
- CommentSortOrder
수정 ID별 오름차순 또는 내림차순(기본값은 오름차순)
반환
Promise<WorkItemComments>
getDeletedWorkItem(number, string)
휴지통에서 삭제된 작업 항목을 가져옵니다.
function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>매개 변수
- id
-
number
반환할 작업 항목의 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemDelete>
getDeletedWorkItems(number[], string)
매개 변수에 ID가 지정된 휴지통에서 작업 항목을 가져옵니다.
function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>매개 변수
- ids
-
number[]
반환할 삭제된 작업 항목의 쉼표로 구분된 ID 목록
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemDeleteReference[]>
getDeletedWorkItemShallowReferences(string)
휴지통에서 삭제된 작업 항목의 ID 및 URL 목록을 가져옵니다.
function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemDeleteShallowReference[]>
getField(string, string)
특정 필드에 대한 정보를 가져옵니다.
function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>매개 변수
- fieldNameOrRefName
-
string
필드 단순 이름 또는 참조 이름
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemField>
getFields(string, GetFieldsExpand)
모든 필드에 대한 정보를 반환합니다. 프로젝트 ID/이름 매개 변수는 선택 사항입니다.
function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- expand
- GetFieldsExpand
확장 필드를 포함하려면 ExtensionFields를 사용하고, 그렇지 않으면 제외합니다. 이 매개 변수에 대한 기능 플래그를 사용하도록 설정하지 않으면 확장 필드가 항상 포함됩니다.
반환
Promise<WorkItemField[]>
getQueries(string, QueryExpand, number, boolean)
루트 쿼리 및 해당 자식을 가져옵니다.
function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- expand
- QueryExpand
결과에 쿼리 문자열(wiql), 절, 쿼리 결과 열 및 정렬 옵션을 포함합니다.
- depth
-
number
쿼리 폴더에서 자식 쿼리 및 폴더를 이 깊이로 반환합니다.
- includeDeleted
-
boolean
삭제된 쿼리 및 폴더 포함
반환
Promise<QueryHierarchyItem[]>
getQueriesBatch(QueryBatchGetRequest, string)
ID별 쿼리 목록 가져오기(최대 1000)
function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>매개 변수
- queryGetRequest
- QueryBatchGetRequest
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<QueryHierarchyItem[]>
getQuery(string, string, QueryExpand, number, boolean, boolean)
개별 쿼리 및 해당 자식을 검색합니다.
function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- query
-
string
쿼리의 ID 또는 경로입니다.
- expand
- QueryExpand
결과에 쿼리 문자열(wiql), 절, 쿼리 결과 열 및 정렬 옵션을 포함합니다.
- depth
-
number
쿼리 폴더에서 자식 쿼리 및 폴더를 이 깊이로 반환합니다.
- includeDeleted
-
boolean
삭제된 쿼리 및 폴더 포함
- useIsoDateFormat
-
boolean
DateTime 쿼리 절은 ISO 8601 규격 형식을 사용하여 형식이 지정됩니다.
반환
Promise<QueryHierarchyItem>
getQueryResultCount(string, string, string, boolean, number)
쿼리 ID가 지정된 쿼리의 결과를 가져옵니다.
function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>매개 변수
- id
-
string
쿼리 ID입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
- timePrecision
-
boolean
시간 정밀도를 사용할지 여부입니다.
- top
-
number
반환할 최대 결과 수입니다.
반환
Promise<number>
getRecentActivityData()
최근 작업 항목 활동을 가져옵니다.
function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>반환
Promise<AccountRecentActivityWorkItemModel2[]>
getRecentMentions()
내부 전용: 내 회사 계정 페이지에서 사용됩니다.
function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>반환
Promise<AccountRecentMentionWorkItemModel[]>
getRelationType(string)
작업 항목 관계 형식 정의를 가져옵니다.
function getRelationType(relation: string): Promise<WorkItemRelationType>매개 변수
- relation
-
string
관계 이름
반환
Promise<WorkItemRelationType>
getRelationTypes()
작업 항목 관계 형식을 가져옵니다.
function getRelationTypes(): Promise<WorkItemRelationType[]>반환
Promise<WorkItemRelationType[]>
getReportingLinksByLinkType(string, string[], string[], string, Date)
작업 항목 링크 일괄 처리 가져오기
function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- linkTypes
-
string[]
결과를 특정 링크 형식으로 필터링할 형식 목록입니다. 이 매개 변수를 생략하여 모든 링크 형식의 작업 항목 링크를 가져옵니다.
- types
-
string[]
결과를 특정 작업 항목 형식으로 필터링하는 형식 목록입니다. 이 매개 변수를 생략하여 모든 작업 항목 유형의 작업 항목 링크를 가져옵니다.
- continuationToken
-
string
일괄 처리를 시작할 continuationToken을 지정합니다. 이 매개 변수를 생략하여 링크의 첫 번째 일괄 처리를 가져옵니다.
- startDateTime
-
Date
링크 변경의 시작점으로 사용할 날짜/시간입니다. 해당 날짜/시간 이후에 발생한 링크 변경 내용만 반환됩니다. '워터마크' 매개 변수와 함께 사용할 수 없습니다.
반환
Promise<ReportingWorkItemLinksBatch>
getRevision(number, number, string, WorkItemExpand)
요청된 수정 버전에 대해 완전히 수화된 작업 항목을 반환합니다.
function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>매개 변수
- id
-
number
- revisionNumber
-
number
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- expand
- WorkItemExpand
반환
Promise<WorkItem>
getRevisions(number, string, number, number, WorkItemExpand)
페이징된 전체 수화 작업 항목 수정 버전 목록을 반환합니다.
function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>매개 변수
- id
-
number
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- top
-
number
- skip
-
number
- expand
- WorkItemExpand
반환
Promise<WorkItem[]>
getRootNodes(string, number)
프로젝트 아래에 있는 루트 분류 노드를 가져옵니다.
function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- depth
-
number
가져올 자식의 깊이입니다.
반환
Promise<WorkItemClassificationNode[]>
getTemplate(string, string, string)
지정된 ID가 있는 템플릿을 가져옵니다.
function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
- templateId
-
string
템플릿 ID
반환
Promise<WorkItemTemplate>
getTemplates(string, string, string)
템플릿을 가져옵니다.
function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
- workitemtypename
-
string
선택 사항으로 지정된 경우 지정된 작업 항목 형식에 대한 템플릿을 반환합니다.
반환
Promise<WorkItemTemplateReference[]>
getUpdate(number, number, string)
작업 항목에 대한 단일 업데이트를 반환합니다.
function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>매개 변수
- id
-
number
- updateNumber
-
number
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemUpdate>
getUpdates(number, string, number, number)
작업 항목 수정 버전 간의 델타를 반환합니다.
function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>매개 변수
- id
-
number
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- top
-
number
- skip
-
number
반환
Promise<WorkItemUpdate[]>
getWorkArtifactLinkTypes()
아웃바운드 아티팩트 링크 유형을 추적하는 작업 항목 목록을 가져옵니다.
function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>반환
Promise<WorkArtifactLink[]>
getWorkItem(number, string, string[], Date, WorkItemExpand)
단일 작업 항목을 반환합니다.
function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>매개 변수
- id
-
number
작업 항목 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fields
-
string[]
요청된 필드의 쉼표로 구분된 목록
- asOf
-
Date
AsOf UTC 날짜 시간 문자열
- expand
- WorkItemExpand
작업 항목 특성에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Relations, Fields, Links, All }입니다.
반환
Promise<WorkItem>
getWorkItemIconJson(string, string, number)
친숙한 이름과 아이콘 색이 지정된 작업 항목 아이콘을 가져옵니다.
function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>매개 변수
- icon
-
string
아이콘의 이름
- color
-
string
아이콘의 6자리 16진수 색
- v
-
number
아이콘의 버전(캐시 무효화에만 사용됨)
반환
Promise<WorkItemIcon>
getWorkItemIcons()
모든 작업 항목 아이콘 목록을 가져옵니다.
function getWorkItemIcons(): Promise<WorkItemIcon[]>반환
Promise<WorkItemIcon[]>
getWorkItemIconSvg(string, string, number)
친숙한 이름과 아이콘 색이 지정된 작업 항목 아이콘을 가져옵니다.
function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>매개 변수
- icon
-
string
아이콘의 이름
- color
-
string
아이콘의 6자리 16진수 색
- v
-
number
아이콘의 버전(캐시 무효화에만 사용됨)
반환
Promise<any>
getWorkItemIconXaml(string, string, number)
친숙한 이름과 아이콘 색이 지정된 작업 항목 아이콘을 가져옵니다.
function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>매개 변수
- icon
-
string
아이콘의 이름
- color
-
string
아이콘의 6자리 16진수 색
- v
-
number
아이콘의 버전(캐시 무효화에만 사용됨)
반환
Promise<any>
getWorkItemNextStatesOnCheckinAction(number[], string)
지정된 작업 항목 ID의 다음 상태를 반환합니다.
function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>매개 변수
- ids
-
number[]
작업 항목 ID 목록
- action
-
string
가능한 작업입니다. 현재는 체크 인만 지원합니다.
반환
Promise<WorkItemNextStateOnTransition[]>
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)
작업 항목 목록을 반환합니다(최대 200개).
function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>매개 변수
- ids
-
number[]
요청된 작업 항목 ID의 쉼표로 구분된 목록입니다. (최대 200개의 ID가 허용됨).
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fields
-
string[]
요청된 필드의 쉼표로 구분된 목록
- asOf
-
Date
AsOf UTC 날짜 시간 문자열
- expand
- WorkItemExpand
작업 항목 특성에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Relations, Fields, Links, All }입니다.
- errorPolicy
- WorkItemErrorPolicy
대량 작업 항목 가져오기 요청에서 오류 정책을 제어하는 플래그입니다. 가능한 옵션은 {Fail, Omit}입니다.
반환
Promise<WorkItem[]>
getWorkItemsBatch(WorkItemBatchGetRequest, string)
작업 항목 ID 목록의 작업 항목을 가져옵니다(최대 200개).
function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>매개 변수
- workItemGetRequest
- WorkItemBatchGetRequest
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItem[]>
getWorkItemStateColors(string[])
내부 전용: 내 계정 작업 환경에 사용됩니다. 여러 프로젝트의 작업 항목 유형 상태 색 가져오기
function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>매개 변수
- projectNames
-
string[]
반환
Promise<ProjectWorkItemStateColors[]>
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)
템플릿에서 단일 작업 항목을 반환합니다.
function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- type
-
string
작업 항목 유형 이름
- fields
-
string
요청된 필드의 쉼표로 구분된 목록
- asOf
-
Date
AsOf UTC 날짜 시간 문자열
- expand
- WorkItemExpand
작업 항목 특성에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Relations, Fields, Links, All }입니다.
반환
Promise<WorkItem>
getWorkItemType(string, string)
작업 항목 형식 정의를 반환합니다.
function getWorkItemType(project: string, type: string): Promise<WorkItemType>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- type
-
string
작업 항목 유형 이름
반환
Promise<WorkItemType>
getWorkItemTypeCategories(string)
모든 작업 항목 유형 범주를 가져옵니다.
function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemTypeCategory[]>
getWorkItemTypeCategory(string, string)
이름별로 특정 작업 항목 유형 범주를 가져옵니다.
function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- category
-
string
범주 이름
반환
Promise<WorkItemTypeCategory>
getWorkItemTypeColorAndIcons(string[])
내부 전용: 색 및 아이콘 공급자에 사용됩니다. 여러 프로젝트에 대한 위트 형식 색 가져오기
function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>매개 변수
- projectNames
-
string[]
반환
Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>
getWorkItemTypeColors(string[])
내부 전용: 내 계정 작업 환경에 사용됩니다. 여러 프로젝트에 대한 위트 형식 색 가져오기
function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>매개 변수
- projectNames
-
string[]
반환
Promise<{ key: string, value: WorkItemTypeColor[] }[]>
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)
자세한 참조가 있는 작업 항목 유형에 대한 필드 목록을 가져옵니다.
function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- type
-
string
작업 항목 유형입니다.
API 응답에 대한 수준을 확장합니다. 속성: allowedvalues, 기본값, isRequired 등을 응답의 일부로 포함합니다. 없음: 이러한 속성을 건너뜁니다.
반환
Promise<WorkItemTypeFieldWithReferences[]>
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)
자세한 참조가 있는 작업 항목 형식에 대한 필드를 가져옵니다.
function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- type
-
string
작업 항목 유형입니다.
- field
-
string
API 응답에 대한 수준을 확장합니다. 속성: allowedvalues, 기본값, isRequired 등을 응답의 일부로 포함합니다. 없음: 이러한 속성을 건너뜁니다.
반환
Promise<WorkItemTypeFieldWithReferences>
getWorkItemTypes(string)
작업 항목 형식 목록을 반환합니다.
function getWorkItemTypes(project: string): Promise<WorkItemType[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemType[]>
getWorkItemTypeStates(string, string)
작업 항목 형식의 상태 이름과 색을 반환합니다.
function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- type
-
string
상태 이름
반환
Promise<WorkItemStateColor[]>
queryById(string, string, string, boolean, number)
쿼리 ID가 지정된 쿼리의 결과를 가져옵니다.
function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>매개 변수
- id
-
string
쿼리 ID입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
- timePrecision
-
boolean
시간 정밀도를 사용할지 여부입니다.
- top
-
number
반환할 최대 결과 수입니다.
반환
Promise<WorkItemQueryResult>
queryByWiql(Wiql, string, string, boolean, number)
해당 WIQL이 지정된 쿼리의 결과를 가져옵니다.
function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>매개 변수
- wiql
- Wiql
WIQL을 포함하는 쿼리입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
- timePrecision
-
boolean
시간 정밀도를 사용할지 여부입니다.
- top
-
number
반환할 최대 결과 수입니다.
반환
Promise<WorkItemQueryResult>
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)
지정된 아티팩트 URI 목록에 연결된 작업 항목을 쿼리합니다.
function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>매개 변수
- artifactUriQuery
- ArtifactUriQuery
작업 항목을 쿼리하기 위한 아티팩트 URI 목록을 정의합니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<ArtifactUriQueryResult>
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)
삭제된 항목을 포함하는 옵션을 사용하여 작업 항목 수정 버전 일괄 처리 가져오기
function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fields
-
string[]
작업 항목 수정 버전에서 반환할 필드 목록입니다. 이 매개 변수를 생략하여 모든 보고 가능한 필드를 가져옵니다.
- types
-
string[]
결과를 특정 작업 항목 형식으로 필터링하는 형식 목록입니다. 이 매개 변수를 생략하여 모든 작업 항목 유형의 작업 항목 수정 버전을 가져옵니다.
- continuationToken
-
string
일괄 처리를 시작할 워터마크를 지정합니다. 이 매개 변수를 생략하여 첫 번째 수정 버전 일괄 처리를 가져옵니다.
- startDateTime
-
Date
수정 버전에 대한 시작점으로 사용할 날짜/시간이며, 모든 수정 버전은 이 날짜/시간 이후에 발생합니다. '워터마크' 매개 변수와 함께 사용할 수 없습니다.
- includeIdentityRef
-
boolean
ID 필드에 대한 문자열 값 대신 ID 참조를 반환합니다.
- includeDeleted
-
boolean
삭제된 항목을 반환할지 지정합니다.
- includeTagRef
-
boolean
System.Tags 필드에 태그 개체를 반환해야 하는지 지정합니다.
- includeLatestOnly
-
boolean
모든 기록 수정 버전을 건너뛰고 작업 항목의 최신 수정 버전만 반환합니다.
- expand
- ReportingRevisionsExpand
기본적으로 반환되지 않는 긴 텍스트 필드를 포함하여 작업 항목 수정 버전에 있는 모든 필드를 반환합니다.
- includeDiscussionChangesOnly
-
boolean
기록 필드만 변경된 작업 항목의 수정 버전만 반환합니다.
- maxPageSize
-
number
이 일괄 처리에서 반환할 최대 결과 수
반환
Promise<ReportingWorkItemRevisionsBatch>
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)
작업 항목 수정 버전 일괄 처리를 가져옵니다. 필드 목록이 길이 제한을 초과하여 URL을 실행할 수 있을 만큼 충분히 큰 경우 이 요청을 사용할 수 있습니다.
function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>매개 변수
요청 설정을 포함하는 개체: 필드 필터, 형식 필터, ID 형식
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- continuationToken
-
string
일괄 처리를 시작할 워터마크를 지정합니다. 이 매개 변수를 생략하여 첫 번째 수정 버전 일괄 처리를 가져옵니다.
- startDateTime
-
Date
수정 버전에 대한 시작점으로 사용할 날짜/시간이며, 모든 수정 버전은 이 날짜/시간 이후에 발생합니다. '워터마크' 매개 변수와 함께 사용할 수 없습니다.
- expand
- ReportingRevisionsExpand
반환
Promise<ReportingWorkItemRevisionsBatch>
replaceTemplate(WorkItemTemplate, string, string, string)
템플릿 내용 바꾸기
function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>매개 변수
- templateContent
- WorkItemTemplate
바꿀 템플릿 내용
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- team
-
string
팀 ID 또는 팀 이름
- templateId
-
string
템플릿 ID
반환
Promise<WorkItemTemplate>
restoreWorkItem(WorkItemDeleteUpdate, number, string)
휴지통에서 삭제된 작업 항목을 복원합니다.
function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>매개 변수
- payload
- WorkItemDeleteUpdate
IsDeleted 플래그를 false로 업데이트하는 지침이 포함된 Paylod
- id
-
number
복원할 작업 항목의 ID
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemDelete>
searchQueries(string, string, number, QueryExpand, boolean)
사용자가 현재 프로젝트에서 액세스할 수 있는 모든 쿼리를 검색합니다.
function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- filter
-
string
쿼리를 필터링할 텍스트입니다.
- top
-
number
반환할 쿼리 수입니다(기본값은 50이고 최대값은 200).
- expand
- QueryExpand
- includeDeleted
-
boolean
삭제된 쿼리 및 폴더 포함
반환
Promise<QueryHierarchyItemsResult>
sendMail(SendMailBody, string)
선택한/쿼리된 작업 항목에 대한 메일을 보내는 RESTful 메서드입니다.
function sendMail(body: SendMailBody, project?: string): Promise<void>매개 변수
- body
- SendMailBody
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<void>
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)
기존 분류 노드를 업데이트합니다.
function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>매개 변수
- postedNode
- WorkItemClassificationNode
만들거나 업데이트할 노드입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- structureGroup
- TreeStructureGroup
분류 노드, 영역 또는 반복의 구조 그룹입니다.
- path
-
string
분류 노드의 경로입니다.
반환
Promise<WorkItemClassificationNode>
updateField(UpdateWorkItemField, string, string)
필드를 업데이트합니다.
function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>매개 변수
- payload
- UpdateWorkItemField
페이로드에는 필드 속성의 원하는 값이 포함됩니다.
- fieldNameOrRefName
-
string
업데이트할 필드의 이름/참조 이름
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WorkItemField>
updateQuery(QueryHierarchyItem, string, string, boolean)
쿼리 또는 폴더를 업데이트합니다. 이렇게 하면 쿼리 및 폴더를 업데이트, 이름 바꾸기 및 이동할 수 있습니다.
function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>매개 변수
- queryUpdate
- QueryHierarchyItem
업데이트할 쿼리입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- query
-
string
업데이트할 쿼리의 ID 또는 경로입니다.
- undeleteDescendants
-
boolean
이 폴더의 자식을 삭제 취소합니다. 이렇게 하면 이전에 하위 항목에 적용된 권한 변경 내용을 다시 가져오지 않습니다.
반환
Promise<QueryHierarchyItem>
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)
단일 작업 항목을 업데이트.
function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>매개 변수
- document
- JsonPatchDocument
업데이트를 나타내는 JSON 패치 문서
- id
-
number
업데이트할 작업 항목의 ID입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- validateOnly
-
boolean
작업 항목을 저장하지 않고 변경 내용의 유효성을 검사할 것인지 여부를 나타냅니다.
- bypassRules
-
boolean
이 업데이트에 작업 항목 유형 규칙을 적용하지 마세요.
- suppressNotifications
-
boolean
이 변경에 대한 알림을 실행하지 마세요.
- expand
- WorkItemExpand
작업 항목 특성에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Relations, Fields, Links, All }입니다.
반환
Promise<WorkItem>
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)
작업 항목 유형 추가/업데이트
function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>매개 변수
- updateModel
- WorkItemTypeTemplateUpdateModel
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<ProvisioningResult>