v1

latestSwagger 2.02026-07-13285166341.1 KB

Steps

Get a Step by ID

Gets a Step by ID. When successful, the response is the requested Step. If unsuccessful, an appropriate ApiError is returned. Steps.Read permission is required.

get/api/v2/steps/{stepID}

Path parameters

stepIDinteger required

The ID of the Step to get.

Query parameters

isIncludeDeletedboolean

Does it include deleted step, or not

Response

StepIDinteger

The ID of the step

Namestring required

The name of the step

ConfigRequiredboolean required

Indicates if the step requires configuration values to be provided by the build agent

Descriptionstring

A description of the step to be presented to a user

ImplementationIDstring required

The implementation ID used to lookup the step implementation when it is executed

Deletedboolean

Read Only. Indicates if the record is deleted.