depots.asc #1

=== Helix Versioning Engine Depots

[[get_helix_versioning_engine_vX_depots]]
==== `GET /helix_versioning_engine/v[api]/depots`
    
Lists available depots in the system.
The resources of this list are summaries of depots 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_depots.html[`p4 -ztag depots`] command.
For more field information refer to the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_depots.html[command reference].

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

An example response body might look like:

[source,json]
----
[
  {
    "name": "depot",
    "time": "1437690306",
    "type": "local",
    "map": "depot/...",
    "desc": "Default depot"
  },
  {
    "name": "stream-test",
    "time": "1437690307",
    "type": "stream",
    "map": "depot/...",
    "desc": "A test depot\n"
  }
]
----

===== Ruby Client

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




[[post_helix_versioning_engine_vX_depots]]
==== `POST /helix_versioning_engine/v[api]/depots`
    
Creates a new depot specification, like the `p4 depot` 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_depot.html[p4 depot] command.

For example:

[source,json]
----
{
  "Depot": "new_depot",
  "Description": "A new depot for stuff",
  "Type": "local",
  "Map": "new_depot/..."
}
----

===== 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_depot-instance_method[`HelixWebServicesClient#create_depot`]




[[get_helix_versioning_engine_vX_depots_depot]]
==== `GET /helix_versioning_engine/v[api]/depots/[depot]`

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

===== Request URL Path Parameters

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

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

| depot
| The depot 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_depot.html[`p4 -ztag depot [depot 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]
----
{
  "Depot": "depot",
  "Date": "2015/07/23 15:25:06",
  "Description": "Default depot\n",
  "Type": "local",
  "Map": "depot/..."
}
----

===== Ruby Client

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




[[patch_helix_versioning_engine_vX_depots_depot]]
==== `PATCH /helix_versioning_engine/v[api]/depots/[depot]`
    
Update depot specifications, similar to the `p4 depot` 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.

| depot
| The name of the depot
|===

===== 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_depot.html[`p4 -ztag depot [depot name]`] command.

===== Response Headers

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

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

===== Example JSON Request Body

[source,json]
----
{
  "Description": "The updated new-depot description.\n"
}
----

===== Ruby Client

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




[[delete_helix_versioning_engine_vX_depots_depot]]
===== `DELETE /helix_versioning_engine/v[api]/depots/[depot]`
    
Removes the depot specification, similar to the `p4 depot -d` command.

====== Request URL Path Parameters

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

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

| depot
| The name of the depot
|===

===== 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_depot-instance_method[`HelixWebServicesClient#delete_depot`]