Processes - Check Template Existence

  • Reference
Service:
Work Item Tracking Process Template
API Version:
4.1-preview.1

Check if process template exists.

POST https://{instance}/{collection}/_apis/work/processadmin/processes/checktemplateexistence?api-version=4.1-preview.1

URI Parameters

Name In Required Type Description
collection
 path True

string

The name of the Team Foundation Server collection.
instance
 path True

string

TFS server name ({server:port})
api-version
 query True

string

Version of the API to use. This should be set to '4.1-preview.1' to use this version of the api.

Request Body

Media Types: "application/octet-stream"

Name Type Description
body

string

Stream to upload

Responses

Name Type Description
200 OK

CheckTemplateExistenceResult

successful operation

Security

accessToken

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

Type: basic

Examples

Sample Request

POST https://{instance}/{collection}/_apis/work/processadmin/processes/checktemplateexistence?api-version=4.1-preview.1

Sample Response

Status code:
200 
persistent-Auth: true
lfs-Authenticate: NTLM
Response Body
{
  "doesTemplateExist": true,
  "requestedTemplateName": "CustomAgile",
  "existingTemplateName": "CustomAgile",
  "existingTemplateTypeId": "adcc42ab-9882-485e-a3ed-7678f01f66bd"
}

Definitions

CheckTemplateExistenceResult

Describes result of a check template existence request.

Name Type Description
doesTemplateExist

boolean

Indicates whether a template exists.
existingTemplateName

string

The name of the existing template.
existingTemplateTypeId

string

The existing template type identifier.
requestedTemplateName

string

The name of the requested template.