<?xml version="1.0" encoding="UTF-8"?> <chapter version="5.0" xml:id="chapter.methods" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>Perforce Web Services HTTP Protocol Reference</title> <para> Each section includes methods related to a particular topic or resource. </para> <section> <title> P4 Web API HTTP Protocol </title> <para> The P4 Web API is our HTTP based abstraction on top of core Perforce server concepts. Most Perforce command methods are represented here. The main difference is that commands that rely on client workspaces, which includes a lot of the 'manipulation' commands. </para> <informaltable> <tgroup cols="2"> <colspec colname="topic" colwidth="*" /> <colspec colname="description" colwidth="*" /> <thead> <row> <entry><para>Topic</para></entry> <entry><para>Description</para></entry> </row> </thead> <tbody> <row> <entry><link linkend="api.branches">Branches</link> </entry> <entry><para>List and manage branch specifications</para></entry> </row> <row> <entry><link linkend="api.changes">Changes</link></entry> <entry><para>Read and create changelists</para></entry> </row> <row> <entry><link linkend="api.clients">Clients</link> </entry> <entry><para>List and manage client specifications</para></entry> </row> <row> <entry><para><link linkend="api.commands">Commands</link></para></entry> <entry><para>Execute generic Perforce methods</para></entry> </row> <row> <entry><link linkend="api.depots">Depots</link> </entry> <entry><para>List and manage depot specifications</para></entry> </row> <row> <entry><link linkend="api.files">Files</link></entry> <entry><para>File browsing and upload methods.</para></entry> </row> <row> <entry><link linkend="api.groups">Groups</link> </entry> <entry><para>List and manage group specifications</para></entry> </row> <row> <entry><link linkend="api.jobs">Jobs</link> </entry> <entry><para>List and manage job specifications</para></entry> </row> <row> <entry><link linkend="api.labels">Labels</link> </entry> <entry><para>List and manage label specifications</para></entry> </row> <row> <entry><link linkend="api.protections">Protections</link></entry> <entry><para>List and update system protections</para></entry> </row> <row> <entry><para><link linkend="api.servers">Servers</link></para></entry> <entry><para>List and manage server specifications</para></entry> </row> <row> <entry><para><link linkend="api.sessions">Sessions</link></para></entry> <entry><para>Manage a Perforce Web API security token</para></entry> </row> <row> <entry><link linkend="api.triggers">Triggers</link></entry> <entry><para>List and update system triggers</para></entry> </row> <row> <entry><para><link linkend="api.users">Users</link></para></entry> <entry><para>Manage Perforce users</para></entry> </row> </tbody> </tgroup> </informaltable> <xi:include href="http_p4_web_api/branches.xml" /> <xi:include href="http_p4_web_api/changes.xml" /> <xi:include href="http_p4_web_api/clients.xml" /> <xi:include href="http_p4_web_api/commands.xml" /> <xi:include href="http_p4_web_api/depots.xml" /> <xi:include href="http_p4_web_api/files.xml" /> <xi:include href="http_p4_web_api/groups.xml" /> <xi:include href="http_p4_web_api/jobs.xml" /> <xi:include href="http_p4_web_api/labels.xml" /> <xi:include href="http_p4_web_api/protections.xml" /> <xi:include href="http_p4_web_api/servers.xml" /> <xi:include href="http_p4_web_api/sessions.xml" /> <xi:include href="http_p4_web_api/triggers.xml" /> <xi:include href="http_p4_web_api/users.xml" /> </section> </chapter>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#2 | 13972 | tjuricek |
Removing old microservice implementations. The system is now mostly a monolith. Eventually there will be a websocket service. |
||
#1 | 13458 | tjuricek |
Revising P4 Web API docbook documentation to become the Perforce Web Services guide. Right now this is just focused on the Qt SDK. The remaining protocol documentation, etc, will happen eventually. |
||
//guest/perforce_software/helix-web-services/main/p4_web_api/p4_web_api/docbook/xml/04_methods.xml | |||||
#1 | 13412 | tjuricek |
Initial version of the web-services mainline. This is a collection of several projects, that will likely often get released together, though many of them may not always be relevant. See the README for more information. |