Pushes - Create

Push changes to the repository.

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1

URI Parameters

Name In Required Type Description
organization
path True
  • string

The name of the Azure DevOps organization.

project
path
  • string

Project ID or project name

repositoryId
path True
  • string

The name or ID of the repository.

api-version
query True
  • string

Version of the API to use. This should be set to '5.1' to use this version of the api.

Request Body

Name Type Description
_links

The class to represent a collection of REST reference links.

commits

Provides properties that describe a Git commit and associated metadata.

date
  • string
pushId
  • integer
pushedBy
refUpdates
repository
url
  • string

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.code_write Grants the ability to read, update, and delete source code, access metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to create and manage pull requests and code reviews and to receive notifications about version control events via service hooks.

Examples

Add a binary file
Add a text file
Delete a file
Initial commit (Create a new branch)
Move a file
Multiple changes
Rename a file
Update a file
Update a file in a new branch

Add a binary file

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "1380164a8118686087e38ce91f36b24b58c2df02"
    }
  ],
  "commits": [
    {
      "comment": "Added new image file.",
      "changes": [
        {
          "changeType": "add",
          "item": {
            "path": "/images/people/default.jpg"
          },
          "newContent": {
            "content": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAUDBAQEAwUEBAQFBQUGBwwIBwcHBw8KCwkMEQ8SEhEPERATFhwXExQaFRARGCEYGhwdHx8fExciJCIeJBweHx7/2wBDAQUFBQcGBw4ICA4eFBEUHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh7/wAARCABkAGQDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDyc4ODkVl6/qkWmWxlcby3CqO9LJqGVO2RFX61wms3cmpag7B9yIcKK4KdK71OypUSVkUNVv7jUbpppjjPbsBVeOPI6YratdKkuyNi5Y+1dZo3giSeDMpUNXS6kYIyp0J1fhPPI4WPSpo7R3PAyfSvadM+HNkyZdzvxx7Gt/Sfh7otq4klRpmHXI4rnnjILY66eW1XueH6T4avrqRcQSMD6LXVL4avLaIKtuVOMdOTXtkdhbwRiO2gRFUYAArM1OyUocnkdwK5njW3c7oZWranh2o2c8DGKaHGefmHWs+S1KLmLIU9UzxXqviCyja1fzYg2Bwcc15vdkJMyAbRnFddGtznnYnDuiyhbR4b7u32qjGD9tPHp/OtWbbEpfoO5NZUIP2ksQWUAHj61sjmexclTcsZwfu/1NFPuItvlhCcbB/WipLWxd123is9PaUwFZJThfmrN0i1yqsR8zHHArZ8YJv1SOHnYijiq9nLFA6FuMGiD924nH3tTttA06O3hj+XMhGScV2+kWq7VO0DNct4XuEvEVl7V2FnJt2gCvLxEm20fQYKEeW6R0WnWqGPJIAq+tumMAZHfNZdrcPs+UH6VpQtPMoAVgDx0rl1O61ivcssZIUDpWPeyOWyFzXSHTJCC8vA96ydVuNOsuJZYw4OACapQuNtJXOX1ZFmgII6j0rx/wAXW72eoMCpC5yDXrGpa1YyllQMRnG4DiuO8WWsWp2zsvLqMiuzDvkep5WNgqi0OCnndrRnx8w6d6uWerXiRRBHtmZiAc20bHH1IrMlDwxvEc8AgVDpBYzYPYr/ADr0bOx4V7Ox1H/CQ6nFGgzZtlc82cX/AMTRWTOfli/65j+ZorK3mbJG/wCLIP8ASEuxgIwxmuSupSZ85+UV6DrNqZrV4nGQRlfavPLuIxyvGwwynFOjK8RVotM9B+HszJZbycD+deiWN3bQoHnkVRjPJrzPw+5h0WJoV3MBjj1rpdP0+N4xfaw7eV2jz19sVxVoKUtT1sPVlCmrHeaV4g055/LTc5H93kV2FhqtvIgVFUHsK8z0XWo21iHSLLTIdOTfteWZcsBjO49sH65rTvr97eITCQeYH2jaMbvesJwtsdVKs5bnZ63duIG3MQK4fXEsY7Oe/uNLlvVt1DSEnCjJAH6mrE+pXM0Hzgnp1NOgeS6jIIUjGGU9CPpUU3Z6mtSnKSOdtNSt7qyM8GhRRQlzGfLYMeO/uOaW/wBKh+z/AGiGPYOjCupjEcalFiQL3AXAqjfwM0TFcAY6CrdR82hMKDS1PG/EHh+WXU1itwMzNha5a0t5LTUJ4JhiSJ1Vh7gn/CvW9Yh2PBOow0Uo+uCa4Xx7bC08a3yRKAZPKfHuRzXo0arkrM8fE4ZQ95GXOPli5/5Zj+tFZkl1eHaGMYwMD6ZorTkZxe1R6tcgNHsJ5I4rgPFVnIl2Z0UlWGTjtXb3DFpWAbGDir2i6ZaanPJa3MYYSIdp/ukVz05cj1Onl9o+VGJ4GVZNMjRyABJXoZtrW62Rj5ljwQDXAaLZ3WkXE1hdwNE6SbkB/iXsa7vSJBtDdSe1YV73uj08JFWszegREjKqoBI5asTxDEV2SDPlqdo+tdRpdm904VxgGm+LrCNYLSHb+7VyzsPXt/WseZs7/ZqOph2MT3FmXG4464GataE0a3giuNyK/AfHQ/54q/ot7LZWslpb2IdGON+Af1pk7GKdIp9i85Jx0qHFlOqnobFzo5A3Fty9iKwr+3e2JVjla6m01CGaNY1cHIwKyfEkWbdmB6UkiufQ891e2kmuUt4mAMkqjJ6VwfxSUR+N/M6booyxPsSP6V3HirUTpVsdUWHzfsxEmw9GxXi3izXb3xFq7386BDjaqIeFFelhoN6nhY6to0Xrma1AiG+LPljP1yaK5to5RjK5460V3aHjXkep6VqNreEXSErFES0qsemPfvUvhXXPtT7kPk3EXK+hrhppI0uZorKabyGO0l+rAetaXhC5trbUZJZrlII1jIG/+I1hOmuU6IVXGSZ6Z4nSfU4oNUtUUvCgMy/xFccgD2NTaDdF4UPpWVo+vQ2lvNfQqt7Dg7lRunrxVXw7rEN7e3Jhi+zoXLLHnJArllTdj0o105XR7PoUm6NG74rP8UamoX7PFln9Ki8JXm6IR/xY4yaTXrC4Fs89vEjTA85P9a5LanpupdaDfD5+zWzPLIA7nOCcVYvBFcLny3lK85jUt+tZPh6/1GIGP+zLcksDvlG88Vvzf2ldRKlzdLEhJ+SIBQeOnFXogpxbMjS5LeS+EcJk3J1GPu/WtnWXzpuSTu6VPptnDYISqgZ6nHJ+tVtVlRz5Q6HmsbqT0HUXKecfECMDwzegr1jPT6GvGtGt4pAzMM/Mv9a9g+Kd0LXQLlDjMq7VrybQAPKcf9NFH869TDt8lzwMZZ1LFqaGIJD+5HMY7e5oqxOF8uD/AK5D+ZoqzAzrZ7eC58y4i81OcKD1rPkuooZyxtldMk7C3Aq5BDNOzCFd4WoxaQ3Mz7mxtQtwO47V0LcxauR6drt1ZMfIRQpJyhOQRV3w7rslvrMcrIqxu21gvua19G8F293aid7hwPTbV9PBVlHIrCaTKkEcehrObjYumpKVz0vQbtUEbxv8pP3u1dc2oRSR7GOQ3BxXnOkRXFvCHhXzIv4lz0960odQdJwGYhSe4rzJQu9D2aVRwWp29tbw43eYwX2NXLNEjywXcPUnmuZsr9WAHmZHoK34dSgS3UKMnvms+R9TujXha5Pd3QVSzjoK5PV9RWO5Vg+B3HrU+uaxEpbDBvZeawLK3m1O7zICId2eRyacYqO5z1azm7ROe+JNtNqHhy7vGBUph0HoBXj8d1LEoEcuwnHbqf8AJr6S8U2SPpEtrsARoipFeBWWnQl3jlQb0m2n24rvwc/daPNx9FppmWb64bH75iAMD2FFa8tnbBY9sJ+5yfXk0V1e0XY4PZPuaGkARTx+WMfvFz74NQRW8aXErKOS5J/M0UUnsX1PQvD6BdHXHripZuCo9eKKK56htHc6LwqoMCg8jNWNZsbcPwpH0oorhv7zPVl8BiwkgDaSvPY1oxk+YVJJGOhNFFa9DniX9M021uC8swZipGBnir9lGiXhjVQFXgUUVjM6qK94NaRTEe3vXE+JfCmiw+C11+3t2hvftRRyjna/PUg5557YoorfB7sxzHZHnTH9zCf+mf8AU0UUV2s8k//Z",
            "contentType": "base64encoded"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "8132acc6e22bc93e8ba3d7fd63306017b6730610",
      "commitId": "fd1062428e0567cfbfcc28ac59d4bea077ce81c1",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:50Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:50Z"
      },
      "comment": "Added new image file.\n",
      "parents": [
        "1380164a8118686087e38ce91f36b24b58c2df02"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/fd1062428e0567cfbfcc28ac59d4bea077ce81c1"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "1380164a8118686087e38ce91f36b24b58c2df02",
      "newObjectId": "fd1062428e0567cfbfcc28ac59d4bea077ce81c1"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 85,
  "date": "2014-12-16T20:41:50.307555Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/85",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/85"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/85/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Add a text file

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "8b67126d2500e28c771f82c9ddc292679978197c"
    }
  ],
  "commits": [
    {
      "comment": "Added task markdown file.",
      "changes": [
        {
          "changeType": "add",
          "item": {
            "path": "/tasks.md"
          },
          "newContent": {
            "content": "# Tasks\n\n* Item 1\n* Item 2",
            "contentType": "rawtext"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "cf58444311c094fae277a7b30898f0f5b0c3c985",
      "commitId": "1380164a8118686087e38ce91f36b24b58c2df02",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:49Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:49Z"
      },
      "comment": "Added task markdown file.\n",
      "parents": [
        "8b67126d2500e28c771f82c9ddc292679978197c"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/1380164a8118686087e38ce91f36b24b58c2df02"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "8b67126d2500e28c771f82c9ddc292679978197c",
      "newObjectId": "1380164a8118686087e38ce91f36b24b58c2df02"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 84,
  "date": "2014-12-16T20:41:49.5419198Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/84",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/84"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/84/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Delete a file

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "fef9b2407969c5921a6ef4f7771a919e1a85de19"
    }
  ],
  "commits": [
    {
      "comment": "Removed default image file.",
      "changes": [
        {
          "changeType": "delete",
          "item": {
            "path": "/images/people/default.jpg"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "09656595ab4a552c059d1372b589aef7ced5b49a",
      "commitId": "7f4fa8e454c196078e1ffca5cd6934515e605c96",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:51Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:51Z"
      },
      "comment": "Removed default image file.\n",
      "parents": [
        "fef9b2407969c5921a6ef4f7771a919e1a85de19"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/7f4fa8e454c196078e1ffca5cd6934515e605c96"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "fef9b2407969c5921a6ef4f7771a919e1a85de19",
      "newObjectId": "7f4fa8e454c196078e1ffca5cd6934515e605c96"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 87,
  "date": "2014-12-16T20:41:51.9325681Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/87",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/87"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/87/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Initial commit (Create a new branch)

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "0000000000000000000000000000000000000000"
    }
  ],
  "commits": [
    {
      "comment": "Initial commit.",
      "changes": [
        {
          "changeType": "add",
          "item": {
            "path": "/readme.md"
          },
          "newContent": {
            "content": "My first file!",
            "contentType": "rawtext"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "404ff66f65520c7a480b343f010b2ce68d7ffbb3",
      "commitId": "8b67126d2500e28c771f82c9ddc292679978197c",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:48Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:48Z"
      },
      "comment": "Initial commit.\n",
      "parents": [],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/8b67126d2500e28c771f82c9ddc292679978197c"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "0000000000000000000000000000000000000000",
      "newObjectId": "8b67126d2500e28c771f82c9ddc292679978197c"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 83,
  "date": "2014-12-16T20:41:48.9579947Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/83",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/83"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/83/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Move a file

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "6e3c1f07d12eaf805a16db1352771816148c24b5"
    }
  ],
  "commits": [
    {
      "comment": "Moving activetasks.md to a new folder.",
      "changes": [
        {
          "changeType": "rename",
          "sourceServerItem": "/activetasks.md",
          "item": {
            "path": "/tasks/content/activetasks.md"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "5587e0b919b64d9cfd3a57bc0236b5c17ce8e6c8",
      "commitId": "b92a68a4cd54506d0d8e264ddddbfe5076dca910",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:53Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:53Z"
      },
      "comment": "Moving activetasks.md to a new folder.\n",
      "parents": [
        "6e3c1f07d12eaf805a16db1352771816148c24b5"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/b92a68a4cd54506d0d8e264ddddbfe5076dca910"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "6e3c1f07d12eaf805a16db1352771816148c24b5",
      "newObjectId": "b92a68a4cd54506d0d8e264ddddbfe5076dca910"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 89,
  "date": "2014-12-16T20:41:53.4638459Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/89",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/89"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/89/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Multiple changes

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "b92a68a4cd54506d0d8e264ddddbfe5076dca910"
    }
  ],
  "commits": [
    {
      "comment": "Updating active tasks and adding a few new files.",
      "changes": [
        {
          "changeType": "edit",
          "item": {
            "path": "/tasks/content/activetasks.md"
          },
          "newContent": {
            "content": "# Tasks\n\n* Item 1\n* Item 2\n* Item 3\n* Item 4\n* Item 5\n* Item 6",
            "contentType": "rawtext"
          }
        },
        {
          "changeType": "add",
          "item": {
            "path": "/tasks/content/newtasks.md"
          },
          "newContent": {
            "content": "# New Tasks\n\nTBD",
            "contentType": "rawtext"
          }
        },
        {
          "changeType": "add",
          "item": {
            "path": "/tasks/content/inactivetasks.md"
          },
          "newContent": {
            "content": "# Inactive Tasks\n\nTBD",
            "contentType": "rawtext"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "ea40b6cc99f3f155a2c7be135e6aa2c82ae8e779",
      "commitId": "2b269bd10e6bd25ec459a0344e8641db395b3219",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:54Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:54Z"
      },
      "comment": "Updating active tasks and adding a few new files.\n",
      "parents": [
        "b92a68a4cd54506d0d8e264ddddbfe5076dca910"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/2b269bd10e6bd25ec459a0344e8641db395b3219"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "b92a68a4cd54506d0d8e264ddddbfe5076dca910",
      "newObjectId": "2b269bd10e6bd25ec459a0344e8641db395b3219"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 91,
  "date": "2014-12-16T20:41:54.7294804Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/91",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/91"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/91/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Rename a file

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "7f4fa8e454c196078e1ffca5cd6934515e605c96"
    }
  ],
  "commits": [
    {
      "comment": "Renaming tasks.md to activetasks.md",
      "changes": [
        {
          "changeType": "rename",
          "sourceServerItem": "/tasks.md",
          "item": {
            "path": "/activetasks.md"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "5e5656e84cd88a8035eaee63c5ab65fba3249d75",
      "commitId": "6e3c1f07d12eaf805a16db1352771816148c24b5",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:52Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:52Z"
      },
      "comment": "Renaming tasks.md to activetasks.md\n",
      "parents": [
        "7f4fa8e454c196078e1ffca5cd6934515e605c96"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/6e3c1f07d12eaf805a16db1352771816148c24b5"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "7f4fa8e454c196078e1ffca5cd6934515e605c96",
      "newObjectId": "6e3c1f07d12eaf805a16db1352771816148c24b5"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 88,
  "date": "2014-12-16T20:41:52.6357345Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/88",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/88"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/88/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Update a file

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/master",
      "oldObjectId": "fd1062428e0567cfbfcc28ac59d4bea077ce81c1"
    }
  ],
  "commits": [
    {
      "comment": "Added a few more items to the task list.",
      "changes": [
        {
          "changeType": "edit",
          "item": {
            "path": "/tasks.md"
          },
          "newContent": {
            "content": "# Tasks\n\n* Item 1\n* Item 2\n* Item 3\n* Item 4\n\nIf you need to add more, update this file and add them!",
            "contentType": "rawtext"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "bd2aeadd55cbc9794c3fac614ab105d07e20d387",
      "commitId": "fef9b2407969c5921a6ef4f7771a919e1a85de19",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:50Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:50Z"
      },
      "comment": "Added a few more items to the task list.\n",
      "parents": [
        "fd1062428e0567cfbfcc28ac59d4bea077ce81c1"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/fef9b2407969c5921a6ef4f7771a919e1a85de19"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/master",
      "oldObjectId": "fd1062428e0567cfbfcc28ac59d4bea077ce81c1",
      "newObjectId": "fef9b2407969c5921a6ef4f7771a919e1a85de19"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 86,
  "date": "2014-12-16T20:41:51.1513097Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/86",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/86"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/86/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/master"
    }
  }
}

Update a file in a new branch

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pushes?api-version=5.1
{
  "refUpdates": [
    {
      "name": "refs/heads/myfirstbranch",
      "oldObjectId": "b92a68a4cd54506d0d8e264ddddbfe5076dca910"
    }
  ],
  "commits": [
    {
      "comment": "Updating active tasks, but saving in a new branch.",
      "changes": [
        {
          "changeType": "edit",
          "item": {
            "path": "/tasks/content/activetasks.md"
          },
          "newContent": {
            "content": "# My Active Tasks\n\n* Item 1\n* Item 2\n* Item 3\n* Item 4\n* Item 5\n",
            "contentType": "rawtext"
          }
        }
      ]
    }
  ]
}

Sample Response

{
  "commits": [
    {
      "treeId": "f2c7729b8fce5c5046db163f7bb4ff502d17b53b",
      "commitId": "bee67802b97da2a274df88855065b110f232973f",
      "author": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:54Z"
      },
      "committer": {
        "name": "Normal Paulk",
        "email": "fabrikamfiber16@hotmail.com",
        "date": "2014-12-16T20:41:54Z"
      },
      "comment": "Updating active tasks, but saving in a new branch.\n",
      "parents": [
        "b92a68a4cd54506d0d8e264ddddbfe5076dca910"
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/commits/bee67802b97da2a274df88855065b110f232973f"
    }
  ],
  "refUpdates": [
    {
      "repositoryId": "8ee9091d-0f54-4633-9bb2-b5ac74855a46",
      "name": "refs/heads/myfirstbranch",
      "oldObjectId": "0000000000000000000000000000000000000000",
      "newObjectId": "bee67802b97da2a274df88855065b110f232973f"
    }
  ],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 90,
  "date": "2014-12-16T20:41:54.0575978Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/90",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/90"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/pushes/90/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/8ee9091d-0f54-4633-9bb2-b5ac74855a46/refs/refs/heads/myfirstbranch"
    }
  }
}

Definitions

ChangeCountDictionary
GitChange
GitCommitRef

Provides properties that describe a Git commit and associated metadata.

GitPush
GitPushRef
GitRefUpdate
GitRepository
GitRepositoryRef
GitStatus

This class contains the metadata of a service/extension posting a status.

GitStatusContext

Status context that uniquely identifies the status.

GitStatusState

State of the status.

GitTemplate
GitUserDate

User info and date for Git operations.

IdentityRef
ItemContent
ItemContentType
ProjectState

Project state.

ProjectVisibility

Project visibility.

ReferenceLinks

The class to represent a collection of REST reference links.

ResourceRef
TeamProjectCollectionReference

Reference object for a TeamProjectCollection.

TeamProjectReference

Represents a shallow reference to a TeamProject.

VersionControlChangeType

The type of change that was made to the item.

ChangeCountDictionary

GitChange

Name Type Description
changeId
  • integer

ID of the change within the group of changes.

changeType

The type of change that was made to the item.

item
  • string

Current version.

newContent

Content of the item after the change.

newContentTemplate

New Content template to be used when pushing new changes.

originalPath
  • string

Original path of item if different from current path.

sourceServerItem
  • string

Path of the item on the server.

url
  • string

URL to retrieve the item.

GitCommitRef

Provides properties that describe a Git commit and associated metadata.

Name Type Description
_links

A collection of related REST reference links.

author

Author of the commit.

changeCounts

Counts of the types of changes (edits, deletes, etc.) included with the commit.

changes

An enumeration of the changes included with the commit.

comment
  • string

Comment or message of the commit.

commentTruncated
  • boolean

Indicates if the comment is truncated from the full Git commit comment message.

commitId
  • string

ID (SHA-1) of the commit.

committer

Committer of the commit.

parents
  • string[]

An enumeration of the parent commit IDs for this commit.

push

The push associated with this commit.

remoteUrl
  • string

Remote URL path to the commit.

statuses

A list of status metadata from services and extensions that may associate additional information to the commit.

url
  • string

REST URL for this resource.

workItems

A list of workitems associated with this commit.

GitPush

Name Type Description
_links

The class to represent a collection of REST reference links.

commits

Provides properties that describe a Git commit and associated metadata.

date
  • string
pushId
  • integer
pushedBy
refUpdates
repository
url
  • string

GitPushRef

Name Type Description
_links

The class to represent a collection of REST reference links.

date
  • string
pushId
  • integer
pushedBy
url
  • string

GitRefUpdate

Name Type Description
isLocked
  • boolean
name
  • string
newObjectId
  • string
oldObjectId
  • string
repositoryId
  • string

GitRepository

Name Type Description
_links

The class to represent a collection of REST reference links.

defaultBranch
  • string
id
  • string
isFork
  • boolean

True if the repository was created as a fork

name
  • string
parentRepository
project

Represents a shallow reference to a TeamProject.

remoteUrl
  • string
size
  • integer

Compressed size (bytes) of the repository.

sshUrl
  • string
url
  • string
validRemoteUrls
  • string[]
webUrl
  • string

GitRepositoryRef

Name Type Description
collection

Team Project Collection where this Fork resides

id
  • string
isFork
  • boolean

True if the repository was created as a fork

name
  • string
project

Represents a shallow reference to a TeamProject.

remoteUrl
  • string
sshUrl
  • string
url
  • string

GitStatus

This class contains the metadata of a service/extension posting a status.

Name Type Description
_links

Reference links.

context

Context of the status.

createdBy

Identity that created the status.

creationDate
  • string

Creation date and time of the status.

description
  • string

Status description. Typically describes current state of the status.

id
  • integer

Status identifier.

state

State of the status.

targetUrl
  • string

URL with status details.

updatedDate
  • string

Last update date and time of the status.

GitStatusContext

Status context that uniquely identifies the status.

Name Type Description
genre
  • string

Genre of the status. Typically name of the service/tool generating the status, can be empty.

name
  • string

Name identifier of the status, cannot be null or empty.

GitStatusState

State of the status.

Name Type Description
error
  • string

Status with an error.

failed
  • string

Status failed.

notApplicable
  • string

Status is not applicable to the target object.

notSet
  • string

Status state not set. Default state.

pending
  • string

Status pending.

succeeded
  • string

Status succeeded.

GitTemplate

Name Type Description
name
  • string

Name of the Template

type
  • string

Type of the Template

GitUserDate

User info and date for Git operations.

Name Type Description
date
  • string

Date of the Git operation.

email
  • string

Email address of the user performing the Git operation.

imageUrl
  • string

Url for the user's avatar.

name
  • string

Name of the user performing the Git operation.

IdentityRef

Name Type Description
_links

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.

descriptor
  • string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

directoryAlias
  • string

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary

displayName
  • string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

id
  • string
imageUrl
  • string

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary

inactive
  • boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary

isAadIdentity
  • boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer
  • boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)

isDeletedInOrigin
  • boolean
profileUrl
  • string

Deprecated - not in use in most preexisting implementations of ToIdentityRef

uniqueName
  • string

Deprecated - use Domain+PrincipalName instead

url
  • string

This url is the full route to the source resource of this graph subject.

ItemContent

Name Type Description
content
  • string
contentType

ItemContentType

Name Type Description
base64Encoded
  • string
rawText
  • string

ProjectState

Project state.

Name Type Description
all
  • string

All projects regardless of state.

createPending
  • string

Project has been queued for creation, but the process has not yet started.

deleted
  • string

Project has been deleted.

deleting
  • string

Project is in the process of being deleted.

new
  • string

Project is in the process of being created.

unchanged
  • string

Project has not been changed.

wellFormed
  • string

Project is completely created and ready to use.

ProjectVisibility

Project visibility.

Name Type Description
private
  • string

The project is only visible to users with explicit access.

public
  • string

The project is visible to all.

The class to represent a collection of REST reference links.

Name Type Description
links
  • object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

ResourceRef

Name Type Description
id
  • string
url
  • string

TeamProjectCollectionReference

Reference object for a TeamProjectCollection.

Name Type Description
id
  • string

Collection Id.

name
  • string

Collection Name.

url
  • string

Collection REST Url.

TeamProjectReference

Represents a shallow reference to a TeamProject.

Name Type Description
abbreviation
  • string

Project abbreviation.

defaultTeamImageUrl
  • string

Url to default team identity image.

description
  • string

The project's description (if any).

id
  • string

Project identifier.

lastUpdateTime
  • string

Project last update time.

name
  • string

Project name.

revision
  • integer

Project revision.

state

Project state.

url
  • string

Url to the full version of the object.

visibility

Project visibility.

VersionControlChangeType

The type of change that was made to the item.

Name Type Description
add
  • string
all
  • string
branch
  • string
delete
  • string
edit
  • string
encoding
  • string
lock
  • string
merge
  • string
none
  • string
property
  • string
rename
  • string
rollback
  • string
sourceRename
  • string
targetRename
  • string
undelete
  • string