Behaviors - Get

Reference

Service:: Work Item Tracking Process Template

API Version:: 7.1-preview.1

Returns a behavior for the process.

GET https://dev.azure.com/{organization}/_apis/work/processadmin/{processId}/behaviors?behaviorRefName={behaviorRefName}&api-version=7.1-preview.1

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 '7.1-preview.1' to use this version of the api.
behaviorRefName	query	True	string	The reference name of the behavior

Responses

Name	Type	Description
200 OK	AdminBehavior	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

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/work/processadmin/{processId}/behaviors?api-version=7.1-preview.1

Sample Response

Status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM

Response Body

{
  "id": "System.RequirementBacklogBehavior",
  "description": "Requirement level backlog and board",
  "abstract": false,
  "overriden": true,
  "custom": false,
  "name": "Stories",
  "color": "009CCC",
  "icon": null,
  "fields": [
    {
      "behaviorFieldId": "Order",
      "id": "Microsoft.VSTS.Common.StackRank",
      "name": "Stack Rank"
    },
    {
      "behaviorFieldId": "Effort",
      "id": "Microsoft.VSTS.Scheduling.StoryPoints",
      "name": "Story Points"
    }
  ],
  "inherits": "System.OrderedBehavior",
  "rank": 20
}

Definitions

Name	Description
AdminBehavior	Describes an admin behavior for a process.
AdminBehaviorField	Describes an admin behavior field.

AdminBehavior

Describes an admin behavior for a process.

Name	Type	Description
abstract	boolean	Is the behavior abstract (i.e. can not be associated with any work item type).
color	string	The color associated with the behavior.
custom	boolean	Indicates if the behavior is custom.
description	string	The description of the behavior.
fields	AdminBehaviorField[]	List of behavior fields.
id	string	Behavior ID.
inherits	string	Parent behavior reference.
name	string	The behavior name.
overriden	boolean	Is the behavior overrides a behavior from system process.
rank	integer	The rank.

AdminBehaviorField

Describes an admin behavior field.

Name	Type	Description
behaviorFieldId	string	The behavior field identifier.
id	string	The behavior ID.
name	string	The behavior name.