branches.asc #1

=== Helix Versioning Engine Branches

[[get_helix_versioning_engine_vX_branches]]
==== `GET /helix_versioning_engine/v[api]/branches`
    
Lists available branches in the system.
The resources of this list are summaries of branches in the system.

===== Request URL Path Parameters

[cols="2*", options="header"]
|===
| Parameter
| Description

| `api`
| The Helix Versioning Engine API level.
|===

===== Request Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Authorization`
| See <<authentication>>

| `Accept`
| `application/json`

| `Content-Type`
| `application/json`

| `X-Perforce-Helix_Web_Services-*`
| See <<per_request_configuration>>
|===

===== Response Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Content-Type`
| `application/json`
|===

===== Response Body JSON

The values of this method are based on the result of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_branches.html[`p4 -ztag branches`] command.
For more field information refer to the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_branches.html[command reference].

See <<error_responses>> for the format of failures.

An example response body might look like:

[source,json]
----
[
  {
    "branch": "manually",
    "Update": "1437153920",
    "Access": "1437153920",
    "Owner": "jdoe",
    "Options": "unlocked",
    "Description": "Created by jdoe.\n"
  },
  {
    "branch": "new_branch_CEUXQMYN",
    "Update": "1437164204",
    "Access": "1437164204",
    "Owner": "",
    "Options": "unlocked",
    "Description": "Something for the kids\n"
  }
]
----

===== Ruby Client

See link:./helix_web_services_client_ruby/HelixWebServicesClient.html#branches-instance_method[`HelixWebServicesClient#branches`]




[[post_helix_versioning_engine_vX_branches]]
==== `POST /helix_versioning_engine/v[api]/branches`
    
Creates a new branch specification, like the `p4 branch` command.

There are no other parameters to this method.

===== Request URL Path Parameters

[cols="2*", options="header"]
|===
| Parameter
| Description

| `api`
| The Helix Versioning Engine API level.
|===

===== Request Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Authorization`
| See <<authentication>>

| `Accept`
| `application/json`

| `Content-Type`
| `application/json`

| `X-Perforce-Helix_Web_Services-*`
| See <<per_request_configuration>>
|===

===== Request Body JSON

Properties of the JSON object are the form fields of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_branch.html[p4 branch] command.

[source,json]
----
{
  "Branch": "my-project-main",
  "Description": "Branch my project from main to dev.\n",
  "View": ["//depot/main/my-project/... //depot/dev/my-project/..."]
}
----

===== Response Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Content-Type`
| `application/json`
|===

===== Ruby Client

See link:./helix_web_services_client_ruby/HelixWebServicesClient.html#create_branch-instance_method[`HelixWebServicesClient#create_branch`]




[[get_helix_versioning_engine_vX_branches_branch]]
==== `GET /helix_versioning_engine/v[api]/branches/[branch]`

Return branch details, similar to the `p4 branch -o` command.

===== Request URL Path Parameters

[cols="2*", options="header"]
|===
| Parameter
| Description

| `api`
| The Helix Versioning Engine API level.

| branch
| The branch name.
|===

===== Request Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Authorization`
| See <<authentication>>

| `Accept`
| `application/json`

| `Content-Type`
| `application/json`

| `X-Perforce-Helix_Web_Services-*`
| See <<per_request_configuration>>
|===

===== Response Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Content-Type`
| `application/json`
|===

===== Response Data

Returns the form fields of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_branch.html[`p4 -ztag branch [branch name]`] command.
For more information, see the command reference.
The main difference between the details and list view is the inclusion of the View field.

===== Example JSON Response

[source,json]
----
{
  "Branch": "my-project-main",
  "Update": "2015/07/22 11:34:14",
  "Access": "2015/07/22 11:34:14",
  "Description": "Branch my project from main to dev.\n",
  "Options": "unlocked",
  "View": [
    "//depot/main/my-project/... //depot/dev/my-project/..."
  ]
}
----

===== Ruby Client

See link:./helix_web_services_client_ruby/HelixWebServicesClient.html#branch-instance_method[`HelixWebServicesClient#branch`]




[[patch_helix_versioning_engine_vX_branches_branch]]
==== `PATCH /helix_versioning_engine/v[api]/branches/[branch]`
    
Update branch specifications, similar to the `p4 branch` command.
Only the specified parameters in the body will be changed.

===== Request URL Path Parameters

[cols="2*", options="header"]
|===
| Parameter
| Description

| `api`
| The Helix Versioning Engine API level.

| branch
| The name of the branch
|===

===== Request Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Authorization`
| See <<authentication>>

| `Accept`
| `application/json`

| `Content-Type`
| `application/json`

| `X-Perforce-Helix_Web_Services-*`
| See <<per_request_configuration>>
|===

===== Request Body JSON

A single JSON object containing form fields of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_branch.html[`p4 -ztag branch [branch name]`] command.

===== Response Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Content-Type`
| `application/json`
|===

===== Example JSON Request Body

[source,json]
----
{
  "Description": "The updated my-project-main description.\n",
  "Owner": "saustin"
}
----

===== Ruby Client

See link:./helix_web_services_client_ruby/HelixWebServicesClient.html#update_branch-instance_method[`HelixWebServicesClient#update_branch`]

[source,ruby]
----
client.update_branch({
  "Branch" => 'my_branch_id',
  "Description" => "The updated my-project-main description.\n",
  "Owner" => "saustin"
})
----




[[delete_helix_versioning_engine_vX_branches_branch]]
===== `DELETE /helix_versioning_engine/v[api]/branches/[branch]`
    
Removes the branch specification, similar to the `p4 branch -d` command.

====== Request URL Path Parameters

[cols="2*", options="header"]
|===
| Parameter
| Description

| `api`
| The Helix Versioning Engine API level.

| branch
| The name of the branch
|===

===== Request Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Authorization`
| See <<authentication>>

| `Accept`
| `application/json`

| `Content-Type`
| `application/json`

| `X-Perforce-Helix_Web_Services-*`
| See <<per_request_configuration>>
|===

===== Response Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Content-Type`
| `application/json`
|===

===== Ruby Client

See link:./helix_web_services_client_ruby/HelixWebServicesClient.html#delete_branch-instance_method[`HelixWebServicesClient#delete_branch`]