giip

Issue Management API Reference

This document provides the technical specification for programmatically managing issues and error logs on the GIIP platform.

🔌 Go to Issue Management Feature →

📋 Overview

The Issue Management API is used by automation scripts or AI agents to retrieve and process server failures, error logs, and task statuses. It provides two primary methods of invocation.


🔐 Authentication

Every request must include a valid Secret Key (SK).

  • Header:
    x-api-key: [Your_SK]
  • Body:
    { "token": "[Your_SK]" }
    (for JSON requests)
  • Query:
    ?token=[Your_SK]

🚀 Method 1: Dedicated Endpoint (REST API)

The most intuitive way to interact with issues.

1. List Issues

  • URL:
    GET /api/giipIssues
  • Query Parameters:
    • status
      : (Optional) Issue status (
      READY
      ,
      PENDING
      ,
      DONE
      , etc.)
    • isn
      : (Optional) Specific issue serial number
  • Response:
    { "issues": [...] }

2. Update Issue Status

  • URL:
    POST /api/giipIssues
    or
    PUT /api/giipIssues
  • Body (JSON):
{
  "isn": "7890",
  "status": "DONE",
  "comment": "Closed as cannot reproduce."
}

🚀 Method 2: Universal API Wrapper (giipApiSk2)

A powerful method that directly calls GIIP Stored Procedures. Highly recommended for AI agents.

  • URL:
    POST /api/giipApiSk2
  • Body (Form-data or JSON):
    • token
      :
      [Your_SK]
    • text
      :
      [Command] [Params...]

Common Command Examples

Feature
text
Parameter Value
Description
List Issues
GiipIssueList READY
Fetch only issues in READY status
Get Details
GiipIssueGet 7890
Get detailed info for ISN 7890
Update Status
GiipIssuePut 7890 DONE
Change status of 7890 to DONE

🔍 Response Standard

Returns

200 OK
with JSON data on success.

{
  "issue": {
    "isn": 7890,
    "title": "Disk Usage Warning",
    "status": "READY",
    "regdate": "2026-03-19T14:20:00Z"
  }
}

⚠️ Important Notes

  • 500 Internal Server Error: If you encounter "The term 'if' is not recognized", it is a PowerShell compatibility issue on the server. Ensure the latest patch (v1.0.1+) is applied.
  • CSN Restriction: To access issues belonging to specific project groups, the API key must have the appropriate permissions for those projects.

Version: 1.2 Last Updated: 2026-05-03 Source File:

giipv3/public/help/giip-issue-api.en.md