Operations - Get

Service:

Operations

API Version:

5.1

Gets an operation from the the operationId using the given pluginId.

Some scenarios don’t require a pluginId. If a pluginId is not included in the call then just the operationId will be used to find an operation.

GET https://dev.azure.com/{organization}/_apis/operations/{operationId}?api-version=5.1

With optional parameters:

GET https://dev.azure.com/{organization}/_apis/operations/{operationId}?pluginId={pluginId}&api-version=5.1

URI Parameters

Name	In	Required	Type	Description
operationId	path	True	string uuid	The ID for the operation.
organization	path		string	The name of the Azure DevOps organization.
api-version	query	True	string	Version of the API to use. This should be set to '5.1' to use this version of the api.
pluginId	query		string uuid	The ID for the plugin.

Responses

Name	Type	Description
200 OK	Operation	successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Definitions

Name	Description
Operation	Contains information about the progress or result of an async operation.
OperationResultReference
OperationStatus	The current status of the operation.
ReferenceLinks	The class to represent a collection of REST reference links.

Operation

Contains information about the progress or result of an async operation.

Name	Type	Description
_links	ReferenceLinks	Links to other related objects.
detailedMessage	string	Detailed messaged about the status of an operation.
id	string	Unique identifier for the operation.
pluginId	string	Unique identifier for the plugin.
resultMessage	string	Result message for an operation.
resultUrl	OperationResultReference	URL to the operation result.
status	OperationStatus	The current status of the operation.
url	string	URL to get the full operation object.

OperationResultReference

Name	Type	Description
resultUrl	string	URL to the operation result.

OperationStatus

The current status of the operation.

Name	Type	Description
cancelled	string	The operation was cancelled by the user.
failed	string	The operation completed with a failure.
inProgress	string	The operation is in progress.
notSet	string	The operation does not have a status set.
queued	string	The operation has been queued.
succeeded	string	The operation completed successfully.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.