http.asc #2

=== Project Methods

These methods provide project JSON defined in <<appendix_project_json>>.

If you are extending Helix Web Services to include your project type, see <<project_extensions>>.



[[post_projects_v1_login]]
==== `POST /projects/v1/login`

Generates a login token for accessing projects via this instance.

This may return a p4 ticket, or another kind of ticket, depending upon the backing implementation.
Use of this ticket will generally be used for authenticating requests related to project metadata.

===== Request Headers

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

| `Accept`
| `application/json`, `text/plain`

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

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

===== Request Body JSON

A single JSON object with the following keys

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

| `user`
| The Helix Versioning Engine login

| `password`
| The password for the particular user
|===

===== Response Headers

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

| `Content-Type`
| `application/json`, `text/plain`
|===

===== Response Body

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

The response returns a JSON object with a single `ticket` parameter.

Example response:

[source,json]
----
{
  "ticket": "16A76F005802E742E834163A22A4DED4"
}
----



[[get_projects_v1]]
==== `GET /projects/v1`

Returns an array of projects accessible to the user.

There are two modes available here: details and ID-only.
When details mode is specified, the return value is an array of complete project JSON objects.
ID-only mode returns an array of project IDs only.

===== Request URI Query Parameters

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

| `mode`
| `details` or `id`.
  If `details`, you receive entire project JSON.
  Otherwise, the output should be an array of strings.
| `id`

| `extension`
| Only return projects with the indicated extension type.
  See the extension ID referenced in <<appendix_project_json>>.
  When empty, will return all projects.
|
|===

===== Request Headers

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

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

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

Returns an array of either project IDs, which will be strings, or project JSON.
See <<appendix_project_json>> for project JSON details.

Example return of project IDs:

[source,json]
----
[
    "alpha",
    "beta",
    "gamma",
    "delta"
]
----

Truncated example return of project JSON:

[source,json]
----
[
    {
        "id": "alpha",
        "name": "Project Alpha",
        ... truncated
    },
    {
        "id": "beta",
        "name": "Beta Project",
        ... truncated
    }
]
----




[[get_projects_v1_project]]
==== `GET /projects/v1/[project]`

Returns project details for a particular project.

===== Request Headers

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

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

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

Returns the project JSON structure as defined in <<appendix_project_json>>.