Requests - Get Requests Request Id

Service:

Symbol

API Version:

7.1

Get a symbol request by request identifier.

GET https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests/{requestId}?api-version=7.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
requestId	path	True	string	The symbol request identifier.
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	Request	Successfully retrieved the symbol request as specified by the request identifier.
404 Not Found	Request	The symbol request as specified by the request identifier was not found.

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.symbols	Grants the ability to read symbols.

Examples

Sample request

HTTP

GET https://artifacts.dev.azure.com/fabrikam/_apis/symbol/requests/9dc380b5c295c03188108014a73574987cdef9a4edce00b01c9ec2d05fa97c37?api-version=7.1

Sample response

Status code:

200

{
  "description": "A sample request to demonstrate the Symbol Experience",
  "expirationDate": "2015-08-16T20:14:39",
  "name": "My Sample Request",
  "status": "sealed",
  "createdBy": "00030000CA16C4DA@Live.com",
  "createdDate": "2015-07-17T20:14:39",
  "id": "9dc380b5c295c03188108014a73574987cdef9a4edce00b01c9ec2d05fa97c37",
  "storageETag": "W/\"datetime'2015-07-17T20%3A15%3A24.7522129Z'\"",
  "url": "https://artifacts.dev.azure.com/fabrikam/_apis/Symbol/requests/9dc380b5c295c03188108014a73574987cdef9a4edce00b01c9ec2d05fa97c37"
}

Definitions

Name	Description
IDomainId
Request	Symbol request.
RequestStatus	The status for this request.

IDomainId

Object

Request

Object

Symbol request.

Name	Type	Description
createdBy	string (uuid)	The ID of user who created this item. Optional.
createdDate	string (date-time)	The date time when this item is created. Optional.
description	string	An optional human-facing description.
domainId	IDomainId	The Domain Id where this request lives. This property should not be null.
expirationDate	string (date-time)	An optional expiration date for the request. The request will become inaccessible and get deleted after the date, regardless of its status. On an HTTP POST, if expiration date is null/missing, the server will assign a default expiration data (30 days unless overwridden in the registry at the account level). On PATCH, if expiration date is null/missing, the behavior is to not change whatever the request's current expiration date is.
id	string	An identifier for this item. Optional.
isChunked	boolean	Indicates if request should be chunk dedup
name	string	A human-facing name for the request. Required on POST, ignored on PATCH.
size	integer (int64)	The total Size for this request.
status	RequestStatus	The status for this request.
storageETag	string	An opaque ETag used to synchronize with the version stored at server end. Optional.
url	string	A URI which can be used to retrieve this item in its raw format. Optional. Note this is distinguished from other URIs that are present in a derived resource.

RequestStatus

Enumeration

The status for this request.

Value	Description
created	The request is created, and is open to accepting debug entries.
none	The status of this request is undefined or irrelevant in the current context.
sealed	The request is sealed. No more debug entries can be added to it.
unavailable	The request is no longer available, possibly deleted.