Açıklama
Bu endpoint, veri oluşturma görevini başlatır. İsteğin isteğe bağlı parametreleri vardır ve sonucu JSON veya CSV formatında almanıza olanak tanır. Sistem isteği asenkron olarak işler ve takip için bir görev kimliği (job ID) döndürür.
Endpoint
POST https://yourdomain.pharmahrm.com/crm-api/db-function/run
Kimlik Doğrulama
Bearer Token (zorunlu)
İstek
Başlıklar
| Anahtar | Değer |
|---|---|
| Authorization | Bearer <token>
|
| Content-Type | application/json |
İstek gövdesi
{
"function": "api_get_tasks",
"format": "csv",
"arguments": {
"id": "123"
}
}
Parametreler
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| function | string | Evet | Veriyi oluşturmak için çağrılan backend yöntemi (örn. api_get_tasks) |
| format | string | Evet | Yanıt formatı: json veya csv |
| arguments | objects | Hayır | Belirli fonksiyonlar için gerekli isteğe bağlı parametreler |
Yanıtlar
Başarılı yanıt
200 OK
{
"job_id": 39
}
| Alan | Tür | Açıklama |
|---|---|---|
| job_id | integer | Veri oluşturma görevinin benzersiz kimliği |
Bu job_id ile görevin durumunu kontrol edebilir ve diğer endpoint’lerle sonucu indirebilirsiniz.
Hatalar
4xx / 5xx
{
"message": "Error message string"
}
| Kod | Açıklama |
|---|---|
| 400 - 499 | İstemci hataları (örneğin yanlış giriş) |
| 500 - 599 | Sunucu hataları |