CoreRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
プロパティ
| RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
CoreRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringプロパティ値
string
メソッドの詳細
createConnectedService(WebApiConnectedServiceDetails, string)
function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>パラメーター
- connectedServiceCreationData
- WebApiConnectedServiceDetails
- projectId
-
string
戻り値
Promise<WebApiConnectedService>
createIdentityMru(IdentityData, string)
function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>パラメーター
- mruData
- IdentityData
- mruName
-
string
戻り値
Promise<void>
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)
チーム プロジェクトでチームを作成します。
function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>パラメーター
- team
- WebApiTeam
チームの作成に使用されたチーム データ。
- projectId
-
string
チームを作成するチーム プロジェクトの名前または ID (GUID)。
戻り値
Promise<WebApiTeam>
deleteIdentityMru(IdentityData, string)
function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>パラメーター
- mruData
- IdentityData
- mruName
-
string
戻り値
Promise<void>
deleteProxy(string, string)
function deleteProxy(proxyUrl: string, site?: string): Promise<void>パラメーター
- proxyUrl
-
string
- site
-
string
戻り値
Promise<void>
deleteTeam(string, string)
チームを削除します。
function deleteTeam(projectId: string, teamId: string): Promise<void>パラメーター
- projectId
-
string
削除するチームを含むチーム プロジェクトの名前または ID (GUID)。
- teamId
-
string
削除するチームの名前または ID。
戻り値
Promise<void>
getAllTeams(boolean, number, number, boolean)
すべてのチームのリストを取得します。
function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>パラメーター
- mine
-
boolean
true の場合、ユーザーをメンバーとして要求するすべてのチームを返します。 それ以外の場合は、すべてのチームのユーザーが読み取りアクセス権を持っていることを返します。
- top
-
number
返されるチームの最大数。
- skip
-
number
スキップするチーム数。
- expandIdentity
-
boolean
結果の WebApiTeam オブジェクトで ID 情報を展開するかどうかを示す値。
戻り値
Promise<WebApiTeam[]>
getConnectedServiceDetails(string, string)
function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>パラメーター
- projectId
-
string
- name
-
string
戻り値
Promise<WebApiConnectedServiceDetails>
getConnectedServices(string, ConnectedServiceKind)
function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>パラメーター
- projectId
-
string
- kind
- ConnectedServiceKind
戻り値
Promise<WebApiConnectedService[]>
getIdentityMru(string)
function getIdentityMru(mruName: string): Promise<IdentityRef[]>パラメーター
- mruName
-
string
戻り値
Promise<IdentityRef[]>
getProcessById(string)
ID でプロセスを取得します。
function getProcessById(processId: string): Promise<Process>パラメーター
- processId
-
string
プロセスの ID。
戻り値
Promise<Process>
getProcesses()
getProject(string, boolean, boolean)
指定した ID または名前のプロジェクトを取得します (オプションで機能を含めます)。
function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>パラメーター
- projectId
-
string
- includeCapabilities
-
boolean
チーム プロジェクトの結果に機能 (ソース管理など) を含めます (既定値: false)。
- includeHistory
-
boolean
名前が変更されたプロジェクト (過去にそのような名前を持っていたプロジェクト) 内を検索します。
戻り値
Promise<TeamProject>
getProjectCollection(string)
指定した ID または名前のプロジェクト コレクションを取得します。
function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>パラメーター
- collectionId
-
string
戻り値
Promise<TeamProjectCollection>
getProjectCollections(number, number)
このアプリケーションのプロジェクト コレクション参照を取得します。
function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>パラメーター
- top
-
number
- skip
-
number
戻り値
Promise<TeamProjectCollectionReference[]>
getProjectHistoryEntries(number)
プロジェクトへの変更履歴を取得します。
function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>パラメーター
- minRevision
-
number
履歴に返される最小リビジョン番号。
戻り値
Promise<ProjectInfo[]>
getProjectProperties(string, string[])
チーム プロジェクトのプロパティのコレクションを取得します。
function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>パラメーター
- projectId
-
string
チーム プロジェクト ID。
- keys
-
string[]
チーム プロジェクトのプロパティ名のコンマ区切り文字列。 ワイルドカード文字 ("?" と "*") がサポートされています。 キーが指定されていない場合は、すべてのプロパティが返されます。
戻り値
Promise<ProjectProperty[]>
getProjects(any, number, number, number, boolean)
認証されたユーザーがアクセスできる組織内のすべてのプロジェクトを取得します。
function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>パラメーター
- stateFilter
-
any
特定のチーム プロジェクト状態 (既定値: WellFormed) のチーム プロジェクトをフィルター処理します。
- top
-
number
- skip
-
number
- continuationToken
-
number
すでにフェッチされたプロジェクトの数を示すポインター。
- getDefaultTeamImageUrl
-
boolean
戻り値
Promise<PagedList<TeamProjectReference>>
getProjectsProperties(string[], string[])
複数のプロジェクトのチーム プロジェクト プロパティのコレクションを取得します。
function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>パラメーター
- projectIds
-
string[]
カンマ区切りのチーム プロジェクト ID の文字列
- properties
-
string[]
戻り値
Promise<ProjectProperties[]>
getProjectTeamsByCategory(string, boolean, number, number)
プロジェクト内のユーザーが読み取り可能なチームのリストを取得し、ユーザーがメンバーであるチーム (読み取り可能なリストから除外されます)。
function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>パラメーター
- projectId
-
string
取得するチームを含むチーム プロジェクトの名前または ID (GUID)。
- expandIdentity
-
boolean
結果の WebApiTeam オブジェクトで ID 情報を展開するかどうかを示す値。
- top
-
number
返されるチームの最大数。
- skip
-
number
スキップするチーム数。
戻り値
Promise<CategorizedWebApiTeams>
getProxies(string)
function getProxies(proxyUrl?: string): Promise<Proxy[]>パラメーター
- proxyUrl
-
string
戻り値
Promise<Proxy[]>
getTeam(string, string, boolean)
特定のチームを取得します。
function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>パラメーター
- projectId
-
string
チームを含むチーム プロジェクトの名前または ID (GUID)。
- teamId
-
string
チームの名前または ID (GUID)。
- expandIdentity
-
boolean
結果の WebApiTeam オブジェクトで ID 情報を展開するかどうかを示す値。
戻り値
Promise<WebApiTeam>
getTeamMembersWithExtendedProperties(string, string, number, number)
特定のチームのメンバーのリストを取得します。
function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>パラメーター
- projectId
-
string
チームが属するチーム プロジェクトの名前または ID (GUID)。
- teamId
-
string
チームの名前または ID (GUID) 。
- top
-
number
- skip
-
number
戻り値
Promise<TeamMember[]>
getTeams(string, boolean, number, number, boolean)
チームのリストを取得します。
function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>パラメーター
- projectId
-
string
- mine
-
boolean
true の場合、要求するすべてのチームがユーザーをメンバーとして返し、それ以外の場合は、すべてのチームユーザーが読み取りアクセス権を持っていることを返します。
- top
-
number
返されるチームの最大数。
- skip
-
number
スキップするチーム数。
- expandIdentity
-
boolean
結果の WebApiTeam オブジェクトで ID 情報を展開するかどうかを示す値。
戻り値
Promise<WebApiTeam[]>
queueCreateProject(TeamProject)
作成するプロジェクトをキューに入れます。 GetOperation を使用して、プロジェクトの作成ステータスを定期的に確認します。
function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>パラメーター
- projectToCreate
- TeamProject
作成するプロジェクト。
戻り値
Promise<OperationReference>
queueDeleteProject(string)
削除するプロジェクトをキューに入れます。 GetOperation を使用して、プロジェクトの削除ステータスを定期的に確認します。
function queueDeleteProject(projectId: string): Promise<OperationReference>パラメーター
- projectId
-
string
削除するプロジェクトのプロジェクト ID。
戻り値
Promise<OperationReference>
removeProjectAvatar(string)
プロジェクトのアバターを削除します。
function removeProjectAvatar(projectId: string): Promise<void>パラメーター
- projectId
-
string
プロジェクトの ID または名前。
戻り値
Promise<void>
setProjectAvatar(ProjectAvatar, string)
プロジェクトのアバターを設定します。
function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>パラメーター
- avatarBlob
- ProjectAvatar
アップロードするアバター BLOB データ オブジェクト。
- projectId
-
string
プロジェクトの ID または名前。
戻り値
Promise<void>
setProjectProperties(string, JsonPatchDocument)
チーム プロジェクトのプロパティを作成、更新、および削除します。
function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>パラメーター
- projectId
-
string
チーム プロジェクト ID。
- patchDocument
- JsonPatchDocument
プロパティ操作の配列を表す JSON パッチ ドキュメント。 JSON パッチの詳細については、RFC 6902 を参照してください。 使用できる操作動詞は Add と Remove で、Add はプロパティの作成と更新の両方に使用されます。 パスは、スラッシュとプロパティ名で構成されます。
戻り値
Promise<void>
updateIdentityMru(IdentityData, string)
function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>パラメーター
- mruData
- IdentityData
- mruName
-
string
戻り値
Promise<void>
updateProject(TeamProject, string)
既存のプロジェクトの名前、略語、説明を更新するか、プロジェクトを復元します。
function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>パラメーター
- projectUpdate
- TeamProject
プロジェクトの更新。 プロジェクトを復元するには、状態を wellFormed に設定する必要があります。
- projectId
-
string
更新するプロジェクトのプロジェクト ID。
戻り値
Promise<OperationReference>
updateTeam(WebApiTeam, string, string)
チームの名前や説明を更新します。
function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>パラメーター
- teamData
- WebApiTeam
- projectId
-
string
更新するチームを含むチーム プロジェクトの名前または ID (GUID)。
- teamId
-
string
更新するチームの ID の名前。
戻り値
Promise<WebApiTeam>