Files
citrus-cms/resources/views/guide/api-endpoints.md
T
2026-04-28 21:15:09 +03:00

159 lines
4.6 KiB
Markdown

# Available Endpoints
This document lists all available admin-ajax endpoints accessible via the API.
**Base URL:** `/api/endpoints/{endpoint}`
**Authentication:** Bearer Token required
---
## General
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `cache-views-list` | @api-readonly | json |
| `column-history` | @api-readonly | json |
| `crew-performance` | @api-readonly | json |
| `developer-project-stats` | Execute Developer Project Stats endpoint | json |
| `developer-team-stats` | Execute Developer Team Stats endpoint | json |
| `disk-usage` | Execute Disk Usage endpoint | json |
| `employees` | @api-readonly | json |
| `general-inspection-list` | Execute General Inspection List endpoint | json |
| `get-author-info` | @api-readonly | json |
| `get-document-folders-simple` | @api-readonly | json |
| `get-dynamic-documents` | @api-readonly | json |
| `get-incoming-for-weldlog` | @api-readonly | json |
| `hand-over-status` | @api-readonly | json |
| `progress` | @api-readonly | json |
| `repair-table/defect-type-by-welder` | @api-readonly | json |
| `request-ndt-no-cache` | @api-readonly | json |
## Document Management
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `document-history` | @api-readonly | json |
## Materials
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `material-performance` | @api-readonly | json |
## NDT Operations
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `ndt-calculation` | @api-readonly | json |
| `ndt-calculation-no-cache` | @api-readonly | json |
| `ndt-dashboard` | @api-readonly | json |
| `ndt-list` | @api-readonly | json |
| `ndt-paint-list` | @api-readonly | json |
| `ndt-paint-list-field` | @api-readonly | json |
## Paint Operations
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `paint-info` | @api-readonly | json |
## Register Creator
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `register-creator-progress-status` | @api-readonly | json |
| `register-creator-progress-tracker` | Execute Register Creator Progress Tracker endpoint | html |
| `register-creator-work-permit-placeholders` | @api-readonly | json |
| `register-no-cache` | @api-readonly | json |
| `register-tp` | @api-readonly | json |
| `register-tp-detail` | @api-readonly | json |
## Repair Operations
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `repair-table` | @api-readonly | json |
## Reports
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `report-builder-get-table` | @api-readonly | json |
| `report-builder-sql` | @api-readonly | json |
## RFI Operations
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `rfi-dashboard` | @api-readonly | json |
| `rfi-tasks` | @api-readonly | json |
## System Info
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `si-queue-information` | @api-readonly | html |
## Spool Operations
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `spool-area-release` | @api-readonly | auto |
| `spool-area-release-no-cache` | @api-readonly | json |
| `spool-list-field` | @api-readonly | json |
| `spool-list-no-cache` | @api-readonly | json |
| `spool-release-detail` | @api-readonly | auto |
## Test Packages
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `tp-creator-progress-tracker` | Execute Tp Creator Progress Tracker endpoint | html |
## User Management
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `users` | @api-readonly | json |
## Welding
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `weld-line-comparator` | @api-readonly | json |
## Welder Management
| Endpoint | Description | Response Type |
|----------|-------------|---------------|
| `welder-id-cart` | @api-readonly | json |
| `welder-performance` | @api-readonly | json |
| `welder-qualification-table` | @api-readonly | json |
| `welder-qualification-table2` | @api-readonly | json |
---
## Usage Examples
### cURL
```bash
curl -X GET \
'{base_url}/api/endpoints/users' \
-H 'Authorization: Bearer {your_token}' \
-H 'Accept: application/json'
```
### JavaScript
```javascript
const response = await fetch('/api/endpoints/users', {
headers: {
'Authorization': 'Bearer ' + token,
'Accept': 'application/json'
}
});
const data = await response.json();
```