Processes - Import Process Template

Reference

Service:: Work Item Tracking Process Template

API Version:: 7.1-preview.1

Imports a process from zip file.

POST https://dev.azure.com/{organization}/_apis/work/processadmin/processes/import?api-version=7.1-preview.1

With optional parameters:

POST https://dev.azure.com/{organization}/_apis/work/processadmin/processes/import?ignoreWarnings={ignoreWarnings}&replaceExistingTemplate={replaceExistingTemplate}&api-version=7.1-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.
ignoreWarnings	query		boolean	Ignores validation warnings. Default value is false.
replaceExistingTemplate	query		boolean	Replaces the existing template. Default value is true.

Request Body

Media Types: "application/octet-stream"

Name	Type	Description
body	string	Stream to upload

Responses

Name	Type	Description
200 OK	ProcessImportResult	successful operation

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.work_write	Grants the ability to read, create, and update work items and queries, update board metadata, read area and iterations paths other work item tracking related metadata, execute queries, and to receive notifications about work item events via service hooks.

Examples

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/work/processadmin/processes/import?api-version=7.1-preview.1

Sample Response

Status code:: 202

persistent-Auth: true
lfs-Authenticate: NTLM

Response Body

{
  "id": "adcc42ab-9882-485e-a3ed-7678f01f66bd",
  "promoteJobId": "00000000-0000-0000-0000-000000000000",
  "helpUrl": null,
  "validationResults": [],
  "isNew": false
}

Definitions

Name	Description
CheckTemplateExistenceResult	Describes result of a check template existence request.
ProcessImportResult	Describes the result of a Process Import request.
ValidationIssue
ValidationIssueType

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.

ProcessImportResult

Describes the result of a Process Import request.

Name	Type	Description
checkExistenceResult	CheckTemplateExistenceResult	Check template existence result.
helpUrl	string	Help URL.
id	string	ID of the import operation.
isNew	boolean	Whether this imported process is new.
promoteJobId	string	The promote job identifier.
validationResults	ValidationIssue[]	The list of validation results.

ValidationIssue

Name	Type	Description
description	string
file	string
helpLink	string
issueType	ValidationIssueType
line	integer

ValidationIssueType

Name	Type	Description
error	string
warning	string