Loading...
 
Skip to main content

History: API Access Example

Source of version: 34 (current)

Copy to clipboard
Select an endpoint to view details.

{HTML(wiki="1")}
 <style>
    .sidebar-api {
      width: 250px;
      height: 100vh;
      background-color: #f8f9fa;
      padding-top: 20px;
     overflow-y: auto;
    }
    .sidebar-api .nav-link {
      font-weight: bold;
    }
    .content-api {
      margin-left: 20px;
      padding: 5px;
      flex: 1;
    }
   .feature-api,  .feature-api:hover, .feature-api:active, .feature-api:visited{
     color: gray;
    }
  </style>
{DIV(class="row")}
   {DIV(class="sidebar-api col-4")}
      <nav class="nav flex-column">
      <a class="nav-link nav-api feature-api" data-target="oauth-public-key" href="#">OAuth</a>
      <a class="nav-link nav-api" href="#" data-target="oauth-public-key">/oauth/public-key</a>
      <a class="nav-link nav-api" href="#" data-target="oauth-authorize">/oauth/authorize</a>
      <a class="nav-link nav-api" href="#" data-target="oauth-access_token">/oauth/access_token</a>
      <a class="nav-link nav-api" href="#" data-target="version">/version</a>

      <a class="nav-link nav-api feature-api" href="#" data-target="get-categories">Categories</a>
      <a class="nav-link nav-api" href="#" data-target="get-categories">/categories (GET)</a>
      <a class="nav-link nav-api" href="#" data-target="create-category">/categories (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="update-category">/categories/{categId} (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="delete-category">/categories/{categId} (DELETE)</a>
      <a class="nav-link nav-api" href="#" data-target="categorize">/categorize (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="uncategorize">/uncategorize (POST)</a>

      <a class="nav-link nav-api feature-api" href="#" data-target="get-comments">Comments</a>
      <a class="nav-link nav-api" href="#" data-target="get-comments">/comments (GET)</a>
      <a class="nav-link nav-api" href="#" data-target="create-comments">/comments (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="delete-comments">/comments/{threadId} (DELETE)</a>
     <a class="nav-link nav-api" href="#" data-target="lock-comments">/comments/{threadId}/lock (POST)</a>
     <a class="nav-link nav-api" href="#" data-target="unlock-comments">/comments/{threadId}/unlock (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="approve-comments">/comments/{threadId}/approve (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="reject-comments">/comments/{threadId}/reject (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="archive-comments">/comments/{threadId}/archive (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="unarchive-comments">/comments/{threadId}/unarchive (POST)</a>

      <a class="nav-link nav-api feature-api" href="#" data-target="get-galleries">Galleries</a>
       <a class="nav-link nav-api" href="#" data-target="get-galleries">/galleries (GET)</a>
      <a class="nav-link nav-api" href="#" data-target="create-galleries">/galleries (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="get-info-galleries">/galleries/{galleryId} (GET)</a>
      <a class="nav-link nav-api" href="#" data-target="update-galleries">/galleries/{galleryId}/update (POST)</a>
     <a class="nav-link nav-api" href="#" data-target="move-galleries">/galleries/{galleryId}/move (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="duplicate-galleries">/galleries/{galleryId}/duplicate (POST)</a>
      <a class="nav-link nav-api" href="#" data-target="delete-galleries">/galleries/{id}/delete</a>
      <a class="nav-link nav-api" href="#" data-target="upload-galleries">/galleries/upload</a>
     <a class="nav-link nav-api" href="#" data-target="download-galleries">/galleries/{fileId}/download</a>
      <a class="nav-link nav-api" href="#" data-target="list-files-galleries">/galleries/{galleryId}/list_files</a>
       <a class="nav-link nav-api" href="#" data-target="file-info-galleries">/galleries/files/{fileId}</a>
      <a class="nav-link nav-api" href="#" data-target="file-update-galleries">/galleries/files/{fileId}/update</a>
      <a class="nav-link nav-api" href="#" data-target="file-duplicate-galleries">/galleries/files/{fileId}/duplicate</a>
     <a class="nav-link nav-api" href="#" data-target="file-lock-galleries">/galleries/files/lock</a>
      <a class="nav-link nav-api" href="#" data-target="file-unlock-galleries">/galleries/files/unlock</a>
      <a class="nav-link nav-api" href="#" data-target="file-delete-galleries">/galleries/files/{fileId}/delete</a>

      <a class="nav-link nav-api feature-api" href="#" data-target="get-groups">Groups</a>
       <a class="nav-link nav-api" href="#" data-target="get-groups">/groups (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="create-groups">/groups (POST)</a>
        <a class="nav-link nav-api" href="#" data-target="update-groups">/groups/{olgroup} (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="add-user-groups">/groups/add_users (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="ban-user-groups">/groups/ban_users (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="delete-groups">/groups/delete</a>

       <a class="nav-link nav-api feature-api" href="#" data-target="search-lookup">Search</a>
       <a class="nav-link nav-api" href="#" data-target="search-lookup">/search/lookup (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="search-process-queue">/search/process-queue (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="search-rebuild">/search/rebuild (POST)</a>

       <a class="nav-link nav-api feature-api" href="#" data-target="get-tabulars">Tabulars</a>
       <a class="nav-link nav-api" href="#" data-target="get-tabulars">/tabulars (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="get-info-tabulars">/tabulars/{tabularId} (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="export-tabulars">/tabulars/{tabularId}/export (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="import-tabulars">/tabulars/{tabularId}/import (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="delete-tabulars">/tabulars/{tabularId}/delete</a>

       <a class="nav-link nav-api feature-api" href="#" data-target="get-trackers">Trackers</a>
       <a class="nav-link nav-api" href="#" data-target="get-trackers">/trackers (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="create-trackers">/trackers (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="duplicate-trackers">/trackers/{trackerId}/duplicate (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="update-trackers">/trackers/{trackerId} (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="create-trackers-field">/trackers/{trackerId}/fields (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="create-trackers-item">/trackers/{trackerId}/items (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="get-trackers-item">/trackers/{trackerId} (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="clear-trackers-items">/trackers/{trackerId}/clear (POST)</a>
       <a class="nav-link nav-api" href="#" data-target="dump-trackers-items">/trackers/{trackerId}/dump (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="export-trackers-yaml">/trackers/{trackerId}/export (GET)</a>
       <a class="nav-link nav-api" href="#" data-target="get-trackers-field">/trackers/{trackerId}/fields (GET)</a>
      </nav>
   {DIV}

   {DIV(class="content-api flex-column col-6")}
      {include page="Api Oauth Doc"}
      {include page="Api Categories Doc"}
      {include page="Api Comments Doc"}
      {include page="Api Galleries Doc"}
     {include page="Api Groups Doc"}
     {include page="Api Search Doc"}
     {include page="Api Tabulars Doc"}
     {include page="Api Trackers Doc"}
    {DIV}
{DIV}


 
  {JQ()} $(document).ready(function() {
      $('.nav-api').click(function(e) {
        e.preventDefault();
        var target = $(this).data('target');
        $('.content-section').addClass('d-none');
        $('#' + target).removeClass('d-none');
      });
    });
{JQ}
{HTML}
Show PHP error messages