Behaviors - List

  • Reference
Service:
Work Item Tracking Process
API Version:
5.0-preview.2

Returns a list of all behaviors in the process.

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/behaviors?api-version=5.0-preview.2
With optional parameters: 
GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/behaviors?$expand={$expand}&api-version=5.0-preview.2

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
processId
 path True

string

uuid

The ID of the process
api-version
 query True

string

Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.
$expand
 query

GetBehaviorsExpand

Responses

Name Type Description
200 OK

ProcessBehavior[]

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 process behaviors
Get the list of process behaviors with CombinedFields option
Get the list of process behaviors with Fields option

Get the list of process behaviors

Sample Request

GET https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors?$expand=Fields&api-version=5.0-preview.2

Sample Response

Status code:
200 
{
  "count": 7,
  "value": [
    {
      "name": "MyCustomBehavior",
      "referenceName": "Custom.4b8fdba0-7064-458d-b55c-522b39059a62",
      "color": "009CDD",
      "rank": 50,
      "description": null,
      "customization": "custom",
      "inherits": {
        "behaviorRefName": "System.PortfolioBacklogBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Custom.4b8fdba0-7064-458d-b55c-522b39059a62"
    },
    {
      "name": "Stories",
      "referenceName": "System.RequirementBacklogBehavior",
      "color": "009CCC",
      "rank": 20,
      "description": "Requirement level backlog and board",
      "customization": "inherited",
      "inherits": {
        "behaviorRefName": "System.OrderedBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.RequirementBacklogBehavior"
    },
    {
      "name": "Epics",
      "referenceName": "Microsoft.VSTS.Agile.EpicBacklogBehavior",
      "color": "FF7B00",
      "rank": 40,
      "description": "Epic level backlog and board",
      "customization": "system",
      "inherits": {
        "behaviorRefName": "System.PortfolioBacklogBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Microsoft.VSTS.Agile.EpicBacklogBehavior"
    },
    {
      "name": "Features",
      "referenceName": "Microsoft.VSTS.Agile.FeatureBacklogBehavior",
      "color": "773B93",
      "rank": 30,
      "description": "Feature level backlog and board",
      "customization": "system",
      "inherits": {
        "behaviorRefName": "System.PortfolioBacklogBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Microsoft.VSTS.Agile.FeatureBacklogBehavior"
    },
    {
      "name": "Ordered",
      "referenceName": "System.OrderedBehavior",
      "color": null,
      "rank": 0,
      "description": "Enables work items to be ordered relative to other work items",
      "customization": "system",
      "inherits": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
    },
    {
      "name": "Tasks",
      "referenceName": "System.TaskBacklogBehavior",
      "color": "F2CB1D",
      "rank": 10,
      "description": "Task level backlog and board",
      "customization": "system",
      "inherits": {
        "behaviorRefName": "System.OrderedBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.TaskBacklogBehavior"
    },
    {
      "name": "Portfolio",
      "referenceName": "System.PortfolioBacklogBehavior",
      "color": null,
      "rank": 0,
      "description": "Portfolio level backlog and board",
      "customization": "system",
      "inherits": {
        "behaviorRefName": "System.OrderedBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
    }
  ]
}

Get the list of process behaviors with CombinedFields option

Sample Request

GET https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors?$expand=CombinedFields&api-version=5.0-preview.2

Sample Response

Status code:
200 
{
  "count": 7,
  "value": [
    {
      "name": "MyCustomBehavior",
      "referenceName": "Custom.4b8fdba0-7064-458d-b55c-522b39059a62",
      "color": "009CDD",
      "rank": 50,
      "description": null,
      "customization": "custom",
      "fields": [
        {
          "name": "Stack Rank",
          "referenceName": "Microsoft.VSTS.Common.StackRank",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
        }
      ],
      "inherits": {
        "behaviorRefName": "System.PortfolioBacklogBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Custom.4b8fdba0-7064-458d-b55c-522b39059a62"
    },
    {
      "name": "Stories",
      "referenceName": "System.RequirementBacklogBehavior",
      "color": "009CCC",
      "rank": 20,
      "description": "Requirement level backlog and board",
      "customization": "inherited",
      "fields": [
        {
          "name": "Stack Rank",
          "referenceName": "Microsoft.VSTS.Common.StackRank",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
        },
        {
          "name": "Story Points",
          "referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.StoryPoints"
        }
      ],
      "inherits": {
        "behaviorRefName": "System.OrderedBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.RequirementBacklogBehavior"
    },
    {
      "name": "Epics",
      "referenceName": "Microsoft.VSTS.Agile.EpicBacklogBehavior",
      "color": "FF7B00",
      "rank": 40,
      "description": "Epic level backlog and board",
      "customization": "system",
      "fields": [
        {
          "name": "Stack Rank",
          "referenceName": "Microsoft.VSTS.Common.StackRank",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
        }
      ],
      "inherits": {
        "behaviorRefName": "System.PortfolioBacklogBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Microsoft.VSTS.Agile.EpicBacklogBehavior"
    },
    {
      "name": "Features",
      "referenceName": "Microsoft.VSTS.Agile.FeatureBacklogBehavior",
      "color": "773B93",
      "rank": 30,
      "description": "Feature level backlog and board",
      "customization": "system",
      "fields": [
        {
          "name": "Stack Rank",
          "referenceName": "Microsoft.VSTS.Common.StackRank",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
        }
      ],
      "inherits": {
        "behaviorRefName": "System.PortfolioBacklogBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Microsoft.VSTS.Agile.FeatureBacklogBehavior"
    },
    {
      "name": "Ordered",
      "referenceName": "System.OrderedBehavior",
      "color": null,
      "rank": 0,
      "description": "Enables work items to be ordered relative to other work items",
      "customization": "system",
      "fields": [
        {
          "name": "Stack Rank",
          "referenceName": "Microsoft.VSTS.Common.StackRank",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
        }
      ],
      "inherits": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
    },
    {
      "name": "Tasks",
      "referenceName": "System.TaskBacklogBehavior",
      "color": "F2CB1D",
      "rank": 10,
      "description": "Task level backlog and board",
      "customization": "system",
      "fields": [
        {
          "name": "Stack Rank",
          "referenceName": "Microsoft.VSTS.Common.StackRank",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
        },
        {
          "name": "Remaining Work",
          "referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.RemainingWork"
        },
        {
          "name": "Activity",
          "referenceName": "Microsoft.VSTS.Common.Activity",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Activity"
        }
      ],
      "inherits": {
        "behaviorRefName": "System.OrderedBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.TaskBacklogBehavior"
    },
    {
      "name": "Portfolio",
      "referenceName": "System.PortfolioBacklogBehavior",
      "color": null,
      "rank": 0,
      "description": "Portfolio level backlog and board",
      "customization": "system",
      "fields": [
        {
          "name": "Stack Rank",
          "referenceName": "Microsoft.VSTS.Common.StackRank",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
        }
      ],
      "inherits": {
        "behaviorRefName": "System.OrderedBehavior",
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
    }
  ]
}

Get the list of process behaviors with Fields option

Sample Request

GET https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors?$expand=Fields&api-version=5.0-preview.2

Sample Response

Status code:
200 
{
  "count": 7,
  "value": {
    "count": 7,
    "value": [
      {
        "name": "MyCustomBehavior",
        "referenceName": "Custom.4b8fdba0-7064-458d-b55c-522b39059a62",
        "color": "009CDD",
        "rank": 50,
        "description": null,
        "customization": "custom",
        "fields": [],
        "inherits": {
          "behaviorRefName": "System.PortfolioBacklogBehavior",
          "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
        },
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Custom.4b8fdba0-7064-458d-b55c-522b39059a62"
      },
      {
        "name": "Stories",
        "referenceName": "System.RequirementBacklogBehavior",
        "color": "009CCC",
        "rank": 20,
        "description": "Requirement level backlog and board",
        "customization": "inherited",
        "fields": [
          {
            "name": "Story Points",
            "referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.StoryPoints"
          }
        ],
        "inherits": {
          "behaviorRefName": "System.OrderedBehavior",
          "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
        },
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.RequirementBacklogBehavior"
      },
      {
        "name": "Epics",
        "referenceName": "Microsoft.VSTS.Agile.EpicBacklogBehavior",
        "color": "FF7B00",
        "rank": 40,
        "description": "Epic level backlog and board",
        "customization": "system",
        "fields": [],
        "inherits": {
          "behaviorRefName": "System.PortfolioBacklogBehavior",
          "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
        },
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Microsoft.VSTS.Agile.EpicBacklogBehavior"
      },
      {
        "name": "Features",
        "referenceName": "Microsoft.VSTS.Agile.FeatureBacklogBehavior",
        "color": "773B93",
        "rank": 30,
        "description": "Feature level backlog and board",
        "customization": "system",
        "fields": [],
        "inherits": {
          "behaviorRefName": "System.PortfolioBacklogBehavior",
          "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
        },
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/Microsoft.VSTS.Agile.FeatureBacklogBehavior"
      },
      {
        "name": "Ordered",
        "referenceName": "System.OrderedBehavior",
        "color": null,
        "rank": 0,
        "description": "Enables work items to be ordered relative to other work items",
        "customization": "system",
        "fields": [
          {
            "name": "Stack Rank",
            "referenceName": "Microsoft.VSTS.Common.StackRank",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
          }
        ],
        "inherits": null,
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
      },
      {
        "name": "Tasks",
        "referenceName": "System.TaskBacklogBehavior",
        "color": "F2CB1D",
        "rank": 10,
        "description": "Task level backlog and board",
        "customization": "system",
        "fields": [
          {
            "name": "Remaining Work",
            "referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.RemainingWork"
          },
          {
            "name": "Activity",
            "referenceName": "Microsoft.VSTS.Common.Activity",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Activity"
          }
        ],
        "inherits": {
          "behaviorRefName": "System.OrderedBehavior",
          "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
        },
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.TaskBacklogBehavior"
      },
      {
        "name": "Portfolio",
        "referenceName": "System.PortfolioBacklogBehavior",
        "color": null,
        "rank": 0,
        "description": "Portfolio level backlog and board",
        "customization": "system",
        "fields": [],
        "inherits": {
          "behaviorRefName": "System.OrderedBehavior",
          "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.OrderedBehavior"
        },
        "url": "https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.PortfolioBacklogBehavior"
      }
    ]
  }
}

Definitions

Name Description
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.
GetBehaviorsExpand
ProcessBehavior

Process Behavior Model.
ProcessBehaviorField

Process Behavior Field.
ProcessBehaviorReference

Process behavior Reference.

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.

GetBehaviorsExpand

Name Type Description
combinedFields

string

This option returns fields associated with this behavior and all behaviors from which it inherits.
fields

string

This option returns fields associated with a behavior.
none

string

Default none option.

ProcessBehavior

Process Behavior Model.

Name Type Description
color

string

Color.
customization

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.
description

string

. Description
fields

ProcessBehaviorField[]

Process Behavior Fields.
inherits

ProcessBehaviorReference

Parent behavior reference.
name

string

Behavior Name.
rank

integer

Rank of the behavior
referenceName

string

Behavior Id
url

string

Url of the behavior.

ProcessBehaviorField

Process Behavior Field.

Name Type Description
name

string

Name of the field.
referenceName

string

Reference name of the field.
url

string

Url to field.

ProcessBehaviorReference

Process behavior Reference.

Name Type Description
behaviorRefName

string

Id of a Behavior.
url

string

Url to behavior.