Rules - List
Returns a list of all rules in the work item type of the process.
GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules?api-version=6.0-preview.2URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
process
|
path | True |
string uuid |
The ID of the process |
|
wit
|
path | True |
string |
The reference name of the work item type |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '6.0-preview.2' to use this version of the api. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
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 | Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks. |
Examples
Get the list of rules for the work item type
Sample Request
GET https://dev.azure.com/fabrikam/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules?api-version=6.0-preview.2
Sample Response
{
"count": 59,
"value": [
{
"id": "9c24d726-da1d-48ad-a2e8-032a80fc794b",
"name": "fabrikam",
"conditions": [
{
"conditionType": "$whenChanged",
"field": "System.State",
"value": null
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$copyFromField",
"targetField": "Microsoft.VSTS.Common.Activity",
"value": "10377"
}
],
"customizationType": "custom",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/9c24d726-da1d-48ad-a2e8-032a80fc794b"
},
{
"id": "91be369a-73c4-4d01-ab38-04d87049ffa9",
"name": null,
"conditions": [
{
"conditionType": "$whenNotChanged",
"field": "System.State",
"value": null
}
],
"actions": [
{
"actionType": "$makeReadOnly",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/91be369a-73c4-4d01-ab38-04d87049ffa9"
},
{
"id": "6c27c17f-58ab-4029-a179-06bc4dc355a2",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Committed"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Commitment made by the team"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/6c27c17f-58ab-4029-a179-06bc4dc355a2"
},
{
"id": "72867c92-0c52-44a0-9167-1328fbcd88a4",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Committed"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/72867c92-0c52-44a0-9167-1328fbcd88a4"
},
{
"id": "42248768-4a23-4bd8-b381-66d23af4e2ae",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Moved to the backlog"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/42248768-4a23-4bd8-b381-66d23af4e2ae"
},
{
"id": "115f9ac2-dd50-494b-918a-97a8516b2f34",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/115f9ac2-dd50-494b-918a-97a8516b2f34"
},
{
"id": "345c8580-89dc-438f-9e6e-e8491c881e41",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Removed"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Removed from the backlog"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/345c8580-89dc-438f-9e6e-e8491c881e41"
},
{
"id": "8f51516c-1065-487d-b5d0-1fb4a88af491",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Removed"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/8f51516c-1065-487d-b5d0-1fb4a88af491"
},
{
"id": "1ae0bfb1-45b4-4f40-a924-fbaeaffeed8e",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Work finished"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/1ae0bfb1-45b4-4f40-a924-fbaeaffeed8e"
},
{
"id": "d99f661c-9d40-497e-9558-0a0c06a29978",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/d99f661c-9d40-497e-9558-0a0c06a29978"
},
{
"id": "b7032f1e-445f-4f1e-9305-6de96df02ce8",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Committed"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Commitment made by the team"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/b7032f1e-445f-4f1e-9305-6de96df02ce8"
},
{
"id": "051067db-43ae-403a-a294-969bc8e43db6",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Committed"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/051067db-43ae-403a-a294-969bc8e43db6"
},
{
"id": "14958238-a0de-4d74-b8d7-c69fbf731d78",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Approved by the Product Owner"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/14958238-a0de-4d74-b8d7-c69fbf731d78"
},
{
"id": "f24b8309-b567-44d8-ab2e-48d40b714597",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/f24b8309-b567-44d8-ab2e-48d40b714597"
},
{
"id": "74c2690d-7f1b-49b7-8980-7b4d17d9112c",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Removed"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Removed from the backlog"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/74c2690d-7f1b-49b7-8980-7b4d17d9112c"
},
{
"id": "0d877b6d-b035-4d88-b6bc-4d3366fb46db",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Removed"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/0d877b6d-b035-4d88-b6bc-4d3366fb46db"
},
{
"id": "1aebd167-852a-414e-8034-5830d9e55d3e",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Work finished"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/1aebd167-852a-414e-8034-5830d9e55d3e"
},
{
"id": "708f1da4-1f98-471a-9e6e-da457f09eeac",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/708f1da4-1f98-471a-9e6e-da457f09eeac"
},
{
"id": "69cc8be8-d5ff-4b60-8d6a-e32a7e0a5eca",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Done"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Committed"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Additional work found"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/69cc8be8-d5ff-4b60-8d6a-e32a7e0a5eca"
},
{
"id": "78cd4bff-f2d8-41f4-acd5-d40e99cc33d8",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Done"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Committed"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/78cd4bff-f2d8-41f4-acd5-d40e99cc33d8"
},
{
"id": "b47bc53b-28a9-4cff-87b3-690248cc9724",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Done"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Additional work found"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/b47bc53b-28a9-4cff-87b3-690248cc9724"
},
{
"id": "48526e5d-c4a8-4402-80dc-587e1bb575b6",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Done"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/48526e5d-c4a8-4402-80dc-587e1bb575b6"
},
{
"id": "26d347e6-bcb5-47f2-a584-a1b532def7c9",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Done"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Moved to the backlog"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/26d347e6-bcb5-47f2-a584-a1b532def7c9"
},
{
"id": "cd67c1e9-66e1-4313-93e6-cbd8d3939bd2",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Done"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/cd67c1e9-66e1-4313-93e6-cbd8d3939bd2"
},
{
"id": "935ea2c8-f709-4558-a473-a05ac8ecb0d4",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Work stopped"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/935ea2c8-f709-4558-a473-a05ac8ecb0d4"
},
{
"id": "5d79a948-dd0a-4125-8180-3aa69b7cbdf0",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/5d79a948-dd0a-4125-8180-3aa69b7cbdf0"
},
{
"id": "5ac26615-8b5a-46ef-9466-08a83e24ac95",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Moved to the backlog"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/5ac26615-8b5a-46ef-9466-08a83e24ac95"
},
{
"id": "10d98a67-7b11-41d0-a31b-7854154760ee",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/10d98a67-7b11-41d0-a31b-7854154760ee"
},
{
"id": "9c1a475e-ba68-48a5-90cb-bd797ca56611",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Removed"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Removed from the backlog"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/9c1a475e-ba68-48a5-90cb-bd797ca56611"
},
{
"id": "9f50a68c-03d4-4c43-8bfd-4247de19175e",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Removed"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/9f50a68c-03d4-4c43-8bfd-4247de19175e"
},
{
"id": "e74c42b5-f5ee-4a64-abe5-8e5fd86150e5",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Work finished"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/e74c42b5-f5ee-4a64-abe5-8e5fd86150e5"
},
{
"id": "07dbc08b-16db-4446-b805-e37d802e6f82",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/07dbc08b-16db-4446-b805-e37d802e6f82"
},
{
"id": "a08a718c-6c9d-47d4-98be-a6652f7f463f",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Removed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "Reconsidering backlog item"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/a08a718c-6c9d-47d4-98be-a6652f7f463f"
},
{
"id": "8e25a06a-6988-4b2a-9724-5a6b0d947c65",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Removed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/8e25a06a-6988-4b2a-9724-5a6b0d947c65"
},
{
"id": "5ab5a5ff-02f2-452f-b4a1-1d4f1554e63e",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": ""
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$copyValue",
"targetField": "System.Reason",
"value": "New defect reported"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/5ab5a5ff-02f2-452f-b4a1-1d4f1554e63e"
},
{
"id": "a290fb81-8e54-4f5e-a9b5-038eeff488cc",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": ""
},
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Reason",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/a290fb81-8e54-4f5e-a9b5-038eeff488cc"
},
{
"id": "197931b0-8a49-4302-b8b0-13ac21e0bfdd",
"name": null,
"conditions": [
{
"conditionType": "$when",
"field": "System.CreatedBy",
"value": ""
}
],
"actions": [
{
"actionType": "$setDefaultFromCurrentUser",
"targetField": "System.CreatedBy",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/197931b0-8a49-4302-b8b0-13ac21e0bfdd"
},
{
"id": "2e458121-312c-477c-9bce-82b568ad8667",
"name": null,
"conditions": [
{
"conditionType": "$when",
"field": "System.ChangedBy",
"value": ""
}
],
"actions": [
{
"actionType": "$setDefaultFromCurrentUser",
"targetField": "System.ChangedBy",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/2e458121-312c-477c-9bce-82b568ad8667"
},
{
"id": "a1142df0-0aeb-4770-91a4-a6834a09a1d8",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.WorkItemType",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/a1142df0-0aeb-4770-91a4-a6834a09a1d8"
},
{
"id": "b58ad88f-7185-41a7-bc77-f017d63a3ea8",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.Title",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/b58ad88f-7185-41a7-bc77-f017d63a3ea8"
},
{
"id": "44987c4e-e5a5-4d2a-92e7-aff7bafbbc7c",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.State",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/44987c4e-e5a5-4d2a-92e7-aff7bafbbc7c"
},
{
"id": "7177560d-fc41-4615-a7c8-1552cdb8b39c",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$setDefaultValue",
"targetField": "System.State",
"value": "New"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/7177560d-fc41-4615-a7c8-1552cdb8b39c"
},
{
"id": "62bf02d1-fe63-40d6-aa30-e011a3db12ef",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$setDefaultValue",
"targetField": "Microsoft.VSTS.Common.Priority",
"value": "2"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/62bf02d1-fe63-40d6-aa30-e011a3db12ef"
},
{
"id": "f0e1dafb-4c2d-4e88-9e49-7fc57757ea51",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$setDefaultValue",
"targetField": "Microsoft.VSTS.Common.Severity",
"value": "3 - Medium"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/f0e1dafb-4c2d-4e88-9e49-7fc57757ea51"
},
{
"id": "6f7756b8-7587-476a-99d3-bea5dd98d7aa",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "Microsoft.VSTS.Common.ValueArea",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/6f7756b8-7587-476a-99d3-bea5dd98d7aa"
},
{
"id": "eb51fd17-7fdc-4559-8972-b76d7335062e",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$setDefaultValue",
"targetField": "Microsoft.VSTS.Common.ValueArea",
"value": "Business"
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/eb51fd17-7fdc-4559-8972-b76d7335062e"
},
{
"id": "8351663e-4914-4727-af41-f795468bc85e",
"name": null,
"conditions": [
{
"conditionType": "$whenNotChanged",
"field": "System.State",
"value": null
}
],
"actions": [
{
"actionType": "$makeReadOnly",
"targetField": "Microsoft.VSTS.Common.StateChangeDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/8351663e-4914-4727-af41-f795468bc85e"
},
{
"id": "4775feca-4248-44e4-a966-ac69ba121a10",
"name": null,
"conditions": [
{
"conditionType": "$whenChanged",
"field": "System.State",
"value": null
}
],
"actions": [
{
"actionType": "$copyFromServerClock",
"targetField": "Microsoft.VSTS.Common.StateChangeDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/4775feca-4248-44e4-a966-ac69ba121a10"
},
{
"id": "aa3f1827-8d95-4265-b7cf-f1b494ad42dc",
"name": null,
"conditions": [
{
"conditionType": "$whenNotChanged",
"field": "System.State",
"value": null
}
],
"actions": [
{
"actionType": "$makeReadOnly",
"targetField": "Microsoft.VSTS.Common.ClosedDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/aa3f1827-8d95-4265-b7cf-f1b494ad42dc"
},
{
"id": "48486fc4-75d5-4c43-883e-5dfd07eefce4",
"name": null,
"conditions": [
{
"conditionType": "$when",
"field": "System.State",
"value": "Committed"
}
],
"actions": [
{
"actionType": "$setValueToEmpty",
"targetField": "Microsoft.VSTS.Common.ClosedDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/48486fc4-75d5-4c43-883e-5dfd07eefce4"
},
{
"id": "4c5c17e5-7d92-4986-ba90-784e0dc76270",
"name": null,
"conditions": [
{
"conditionType": "$when",
"field": "System.State",
"value": "Approved"
}
],
"actions": [
{
"actionType": "$setValueToEmpty",
"targetField": "Microsoft.VSTS.Common.ClosedDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/4c5c17e5-7d92-4986-ba90-784e0dc76270"
},
{
"id": "3ce1c2bb-c257-48d2-ab7f-9061e0f6bc38",
"name": null,
"conditions": [
{
"conditionType": "$when",
"field": "System.State",
"value": "New"
}
],
"actions": [
{
"actionType": "$setValueToEmpty",
"targetField": "Microsoft.VSTS.Common.ClosedDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/3ce1c2bb-c257-48d2-ab7f-9061e0f6bc38"
},
{
"id": "8c46445e-6068-49d0-b824-b5ce7ec42e5a",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Committed"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$copyFromServerClock",
"targetField": "Microsoft.VSTS.Common.ClosedDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/8c46445e-6068-49d0-b824-b5ce7ec42e5a"
},
{
"id": "67d83822-a74d-43c1-8bae-32c180874788",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "Approved"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$copyFromServerClock",
"targetField": "Microsoft.VSTS.Common.ClosedDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/67d83822-a74d-43c1-8bae-32c180874788"
},
{
"id": "2f819ee4-f36e-43d9-aa1f-364aa4e31d2b",
"name": null,
"conditions": [
{
"conditionType": "$whenWas",
"field": "System.State",
"value": "New"
},
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$copyFromServerClock",
"targetField": "Microsoft.VSTS.Common.ClosedDate",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/2f819ee4-f36e-43d9-aa1f-364aa4e31d2b"
},
{
"id": "4dc789e3-c4ba-43f3-9df0-11a2e75c3b10",
"name": null,
"conditions": [
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$setValueToEmpty",
"targetField": "Microsoft.VSTS.Scheduling.RemainingWork",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/4dc789e3-c4ba-43f3-9df0-11a2e75c3b10"
},
{
"id": "46d44521-9964-49aa-96cc-32074f539dba",
"name": null,
"conditions": [
{
"conditionType": "$when",
"field": "System.State",
"value": "Done"
}
],
"actions": [
{
"actionType": "$makeReadOnly",
"targetField": "Microsoft.VSTS.Scheduling.Effort",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/46d44521-9964-49aa-96cc-32074f539dba"
},
{
"id": "e7338cf1-6e06-41c6-ad29-0e18dfce1224",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.AreaId",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/e7338cf1-6e06-41c6-ad29-0e18dfce1224"
},
{
"id": "5cd9331e-89cb-4e7a-ab41-b19486077bf3",
"name": null,
"conditions": [],
"actions": [
{
"actionType": "$makeRequired",
"targetField": "System.IterationId",
"value": null
}
],
"customizationType": "system",
"url": "https://dev.azure.com/fabrikam/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/rules/5cd9331e-89cb-4e7a-ab41-b19486077bf3"
}
]
}Definitions
| Name | Description |
|---|---|
|
Customization |
Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process. |
|
Process |
Process Rule Response. |
|
Rule |
Action to take when the rule is triggered. |
|
Rule |
Type of action to take when the rule is triggered. |
|
Rule |
Defines a condition on a field when the rule should be triggered. |
|
Rule |
Type of condition. $When. This condition limits the execution of its children to cases when another field has a particular value, i.e. when the Is value of the referenced field is equal to the given literal value. $WhenNot.This condition limits the execution of its children to cases when another field does not have a particular value, i.e.when the Is value of the referenced field is not equal to the given literal value. $WhenChanged.This condition limits the execution of its children to cases when another field has changed, i.e.when the Is value of the referenced field is not equal to the Was value of that field. $WhenNotChanged.This condition limits the execution of its children to cases when another field has not changed, i.e.when the Is value of the referenced field is equal to the Was value of that field. |
CustomizationType
Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.
| Name | Type | Description |
|---|---|---|
| custom |
string |
Customization-type is Custom if the newly created workitemtype is customized. |
| inherited |
string |
Customization-type is Inherited if the existing workitemtype of inherited process is customized. |
| system |
string |
Customization-type is System if is system generated workitemtype. |
ProcessRule
Process Rule Response.
| Name | Type | Description |
|---|---|---|
| actions |
List of actions to take when the rule is triggered. |
|
| conditions |
List of conditions when the rule should be triggered. |
|
| customizationType |
Indicates if the rule is system generated or created by user. |
|
| id |
string |
Id to uniquely identify the rule. |
| isDisabled |
boolean |
Indicates if the rule is disabled. |
| name |
string |
Name for the rule. |
| url |
string |
Resource Url. |
RuleAction
Action to take when the rule is triggered.
| Name | Type | Description |
|---|---|---|
| actionType |
Type of action to take when the rule is triggered. |
|
| targetField |
string |
Field on which the action should be taken. |
| value |
string |
Value to apply on target field, once the action is taken. |
RuleActionType
Type of action to take when the rule is triggered.
| Name | Type | Description |
|---|---|---|
| copyFromClock |
string |
Set the value from clock. |
| copyFromCurrentUser |
string |
Set the current user to the target field. Example : {"actionType":"$copyFromCurrentUser","targetField":"System.AssignedTo","value":""}. |
| copyFromField |
string |
Copy the value from a specified field and set to target field. Example : {actionType: "$copyFromField", targetField: "System.AssignedTo", value:"System.ChangedBy"}. Here, value is copied from "System.ChangedBy" and set to "System.AssingedTo" field. |
| copyFromServerClock |
string |
Use the current time to set the value of the target field. Example : {actionType: "$copyFromServerClock", targetField: "System.CreatedDate", value: ""} |
| copyFromServerCurrentUser |
string |
Use the current user to set the value of the target field. |
| copyValue |
string |
Set the value of target field to given value. Example : {actionType: "$copyValue", targetField: "ScrumInherited.mypicklist", value: "samplevalue"} |
| disallowValue |
string |
Disallows a field from being set to a specific value. |
| hideTargetField |
string |
Hides target field from the form. This is a server side only action. |
| makeReadOnly |
string |
Make the target field read-only. Example : {"actionType":"$makeReadOnly","targetField":"Microsoft.VSTS.Common.Activity","value":""} |
| makeRequired |
string |
Make the target field required. Example : {"actionType":"$makeRequired","targetField":"Microsoft.VSTS.Common.Activity","value":""} |
| setDefaultFromClock |
string |
Set the default value on the target field from server clock. This is used if user creates the field like Date/Time and uses default value. |
| setDefaultFromCurrentUser |
string |
Set the default current user value on the target field. This is used if the user creates the field of type identity and uses default value. |
| setDefaultFromField |
string |
Set the default value on from existing field to the target field. This used wants to set a existing field value to the current field. |
| setDefaultValue |
string |
Set a default value on the target field. This is used if the user creates a integer/string field and sets a default value of this field. |
| setValueToEmpty |
string |
Set the value of the target field to empty. |
RuleCondition
Defines a condition on a field when the rule should be triggered.
| Name | Type | Description |
|---|---|---|
| conditionType |
Type of condition. $When. This condition limits the execution of its children to cases when another field has a particular value, i.e. when the Is value of the referenced field is equal to the given literal value. $WhenNot.This condition limits the execution of its children to cases when another field does not have a particular value, i.e.when the Is value of the referenced field is not equal to the given literal value. $WhenChanged.This condition limits the execution of its children to cases when another field has changed, i.e.when the Is value of the referenced field is not equal to the Was value of that field. $WhenNotChanged.This condition limits the execution of its children to cases when another field has not changed, i.e.when the Is value of the referenced field is equal to the Was value of that field. |
|
| field |
string |
Field that defines condition. |
| value |
string |
Value of field to define the condition for rule. |
RuleConditionType
Type of condition. $When. This condition limits the execution of its children to cases when another field has a particular value, i.e. when the Is value of the referenced field is equal to the given literal value. $WhenNot.This condition limits the execution of its children to cases when another field does not have a particular value, i.e.when the Is value of the referenced field is not equal to the given literal value. $WhenChanged.This condition limits the execution of its children to cases when another field has changed, i.e.when the Is value of the referenced field is not equal to the Was value of that field. $WhenNotChanged.This condition limits the execution of its children to cases when another field has not changed, i.e.when the Is value of the referenced field is equal to the Was value of that field.
| Name | Type | Description |
|---|---|---|
| when |
string |
$When. This condition limits the execution of its children to cases when another field has a particular value, i.e. when the Is value of the referenced field is equal to the given literal value. |
| whenChanged |
string |
$WhenChanged.This condition limits the execution of its children to cases when another field has changed, i.e.when the Is value of the referenced field is not equal to the Was value of that field. |
| whenCurrentUserIsMemberOfGroup |
string |
|
| whenCurrentUserIsNotMemberOfGroup |
string |
|
| whenNot |
string |
$WhenNot.This condition limits the execution of its children to cases when another field does not have a particular value, i.e.when the Is value of the referenced field is not equal to the given literal value. |
| whenNotChanged |
string |
$WhenNotChanged.This condition limits the execution of its children to cases when another field has not changed, i.e.when the Is value of the referenced field is equal to the Was value of that field. |
| whenStateChangedFromAndTo |
string |
|
| whenStateChangedTo |
string |
|
| whenValueIsDefined |
string |
|
| whenValueIsNotDefined |
string |
|
| whenWas |
string |
|
| whenWorkItemIsCreated |
string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for