Processes - Import Process Template
Imports a process from zip file.
POST https://dev.azure.com/{organization}/_apis/work/processadmin/processes/import?api-version=5.1-preview.1
POST https://dev.azure.com/{organization}/_apis/work/processadmin/processes/import?ignoreWarnings={ignoreWarnings}&replaceExistingTemplate={replaceExistingTemplate}&api-version=5.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 '5.1-preview.1' to use this version of the api. |
ignore
|
query |
boolean |
Ignores validation warnings. Default value is false. |
|
replace
|
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 |
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://dev.azure.com/fabrikam/_apis/work/processadmin/processes/import?api-version=5.1-preview.1
Sample response
persistent-Auth: true
lfs-Authenticate: NTLM
{
"id": "adcc42ab-9882-485e-a3ed-7678f01f66bd",
"promoteJobId": "00000000-0000-0000-0000-000000000000",
"helpUrl": null,
"validationResults": [],
"isNew": false
}
Definitions
Name | Description |
---|---|
Check |
Describes result of a check template existence request. |
Process |
Describes the result of a Process Import request. |
Validation |
|
Validation |
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 |
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 |
The list of validation results. |
ValidationIssue
Name | Type | Description |
---|---|---|
description |
string |
|
file |
string |
|
helpLink |
string |
|
issueType | ||
line |
integer |
ValidationIssueType
Name | Type | Description |
---|---|---|
error |
string |
|
warning |
string |