Pisano Harici API - Akışlar - Akış Detaylarını Göster
Akış Detaylarını Görüntüleme
Akış detaylarını görüntüler.
GET
/external/v1/flows/{flowId}
Kimlik Doğrulama
Kimlik Doğrulama Yöntemi
Token token=<TOKEN>
İstek
Yol Parametreleri
| Parametre | Tip | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
flowId |
string | Evet | Getirilecek akışın ID'si. | flowId |
Header Bilgileri
| Header | Zorunlu | Açıklama | Örnek |
|---|---|---|---|
Accept |
Hayır | Beklenen yanıtın medya türünü belirtir. | application/json |
Authorization |
Evet | İsteğin kimlik doğrulamasını sağlamak için kullanılan Pisano API anahtarı. | Token token=<TOKEN> |
Başarılı Yanıt
200
Başarılı
Yanıt Alanları
| Alan | Tip | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id |
string | Akışın benzersiz tanımlayıcısı. | b1917993-0fea-4b23-8442-a64430ae38a9 |
|
name |
string | Akışın adı. | Test Flow | |
key |
Akış anahtarı. null olabilir. | null |
||
questions |
array | Akışta tanımlanan sorular. | ||
questions[].id |
string | Sorunun benzersiz tanımlayıcısı. | 271b4039-f3a3-4f61-b7a0-8d5b6abe522e |
|
questions[].key |
string / nullable | Soru anahtarı. null olabilir. | question_1 |
|
questions[].body.<language_code> |
string | Belirtilen dildeki soru metni. | How are you? | |
questions[].style |
string | Sorunun türü/stili. | checklist | |
questions[].options |
array | Soru için kullanılabilir seçenekler. Boş olabilir. | ||
questions[].options[].id |
string | Seçeneğin benzersiz tanımlayıcısı. | 271b4039-f3a3-4f61-b7a0-8d5b6abe522e |
|
questions[].options[].key |
string | Seçenek anahtarı. | option_1 |
|
questions[].options[].body.<language_code> |
string | Belirtilen dildeki seçenek metni. | Good |
Yanıt Örneği
JSON
Yanıt Örneği
{
"id": "<flow_id>",
"name": "<flow_name>",
"key": null,
"questions": [
{
"id": "<question_id>",
"key": "<question_key>",
"body": {
"TR": "<question_text>"
},
"style": "score",
"options": [
{
"id": "<option_id>",
"key": "10",
"body": {
"TR": "10"
}
}
]
}
]
}
Hata Yanıtları
401
Hata: Yetkisiz Erişim
Hata: Yetkisiz Erişim
- Hata Kodu
13001- Hata Mesajı
- Wrong authentication token
{"error_message":"Wrong authentication token","data":"Wrong authentication token","code":13001,"errors":null}
404
Hata: Bulunamadı
Hata: Bulunamadı
- Hata Kodu
13002- Hata Mesajı
- Requested resource not found!
{"error_message":"Requested resource not found!","data":"Requested resource not found!","code":13002,"errors":{"flow_id":"b1917993-0fea-4b23-8442-a64430ae38a9"}}