commands.asc #1

=== Helix Versioning Engine Commands

[[get_helix_versioning_engine_vX_commands_command]]
==== `GET /helix_versioning_engine/v[api]/commands/[command]`

Execute a Perforce command that takes no input.

This only allows commands that have been whitelisted on your system.
See the <<system_configuration>> section for details.

===== Request URL Path Parameters

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

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

| `command`
| Yes
| The command name, that should be whitelisted in the system configuration.
  See <<system_configuration>>.
|===

===== 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

Responses are typically an array, mapped from the `p4 -ztag` output of a command.

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

===== Ruby Client

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




[[post_helix_versioning_engine_vX_commands_command]]
==== `POST /helix_versioning_engine/v[api]/commands/[command]`

Execute a Perforce command that accepts input, like a spec.

This only allows commands that have been whitelisted on your system.
See the <<system_configuration>> section for details.

===== Request URL Path Parameters

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

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

| `command`
| Yes
| The command name, that should be whitelisted in the system configuration.
  See <<system_configuration>>.
|===

===== 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

The request body is a JSON structure, which becomes converted to a Ruby hash.
This hash is used as input via the `p4.input` class property of P4Ruby.
See link:http://www.perforce.com/perforce/doc.current/manuals/p4script/ruby.p4.html#ruby.p4.input.eq[`P4.input`] for more information.

===== Response Headers

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

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

===== Response Body JSON

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

===== Ruby Client

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