Görevler
Uç noktalarında kullanılan verilerin türleri ve formatlarının tanımları sayfanın alt kısmında bulunabilir.
Uç Noktaları
Görevleri Getir
GET
https://cubicl.io/api/v1/tasks
Verilen arama kriterlerine uyan görevleri getirir. Yanıtta bazı ayrıntılar döndürülmemektedir. Tüm ayrıntıları almak için ID'e göre Görev Getir isteğini kullanın.
Query Parameters
group
string
Proje ID'si
assignee
string
Görevli ID'si
assignedBy
string
Görev Sahibi ID'si
customer
string
Müşteri ID'si
tag
string
Etiket ismi
startDate
number
Görev başlangıç tarihi. "endDate" parametresi ile kullanılmalıdır.
endDate
number
Görev bitiş tarihi
archived
string
true
: arşivlenmiş görevleri getirir.
false
: arşivlenmemiş görevleri getirir.
all
: tüm görevleri getirir.
Varsayılan değer : false
search
string
Görev adında aranacak metin
recursive
string
true
: alt projeleri de getirir.
Sadece verilen projedeki görevleri almak için boş bırakın.
Varsayılan değer : false
skip
number
limit
number
include
string
Yanıta dahil edilecek alanların virgülle ayrılmış listesi
exclude
string
Yanıtta hariç tutulacak alanların virgülle ayrılmış listesi. "include" ile birlikte kullanılamaz.
Id'e göre Görev Getir
GET
https://cubicl.io/api/v1/tasks/:id
Path Parameters
id*
string
Görev ID'si
Görev Ekle
POST
https://cubicl.io/api/v1/tasks
Request Body
group*
string
Proje ID'si
name*
string
Görev adı
state
string
Aşama adı. Verilmezse, proje detaylarında ayarlanan varsayılan aşama kullanılır.
desc
string
Görev açıklaması
start
number
Başlangıç tarihi
deadline
number
assignees
string[]
Görevli ID'lerin listesi
priority
number
1'den 5'e kadar olabilir.
En yüksek değer : 5
Varsayılan değer : 3
tags
string[]
Etiket ID'leri
customer
string
Müşteri ID'si
files
string[]
Dosya ID'lerinin listesi. Dosya içeren bir görev oluşturmak için, görevi oluşturmadan önce dosyaları yüklemeniz ve ID'lerini burada ayarlamanız gerekir.
stepType
string
none
: görev adımı yok
steps
: kontrol listesi
progress
: ilerleme çubuğu
Varsayılan değer : none
steps
CheckList | ProgressBar
'stepType' değeri 'steps' ise adımları CheckList biçiminde belirtin. ID alanı zorunlu değildir. Sunucuda ayarlanmaktadır.
'stepType' değeri 'progress' ise adımları ProgressBar biçiminde belirtin.
'stepType' değeri 'none' ise bunu ayarlamayın.
recurrent
boolean
Varsayılan değer : false
recurrence
Recurrence
'recurrent' değeri 'true' ise bu ayarlanmalıdır. Yineleme ayrıntıları için aşağıyı kontrol edin.
private
boolean
Varsayılan değer : false
parent
string
Üst görevin ID'si. Görev başka bir görevin alt görevi olarak oluşturulduğunda ayarlanır.
workFlowId
string
Görev bir iş akışı ile oluşturulduğunda ayarlanır.
estimatedTime
number
Görevin saniye cinsinden tahmini teslim süresi. Yalnızca proje ayarlarında etkinleştirildiğinde kullanıcı arayüzünde gösterilir.
customFields
object
Özel alanların adlarının ve değerlerin olduğu bir nesne.
followers
string[]
Görev takipçilerinin ID'leri. Ayarlanmazsa, görev sahibi ve atananlar takipçi olur.
Görev Güncelle
PUT
https://cubicl.io/api/v1/tasks/:id
Bir görevi verilen ayrıntılarla günceller. Tüm ayrıntılar isteğe bağlıdır. Sadece verilen alanlar güncellenir. Bir alanın değerini kaldırmanız gerekirse, değerlerini 'null' veya uygun 'falsy' değerine ayarlayın. Örneğin, dizeler için boş bir dize.
Path Parameters
id*
string
Görev ID'si
Request Body
updateTemplate
boolean
Görev tekrarlanıyorsa, bu alan yalnızca görevin kendisindeki ayrıntıların güncellenip güncellenmeyeceğini veya görevin gelecekteki kopyalarının dahil edilip edilmeyeceğini belirler.
assignees
string[]
Atananların ID'si
customer
string
Müşteri ID'si
customFields
object
Özel alanların adlarının ve değerlerin olduğu bir nesne.
deadline
number
Son teslim tarihi
desc
string
Açıklama
estimatedTime
number
Görevin saniye cinsinden tahmini teslim süresi.
files
string[]
Dosya ID'lerinin listesi
followers
string[]
Görev takipçilerinin ID'leri
group
string
Görevin taşınmak istendiği Proje ID'si
name
string
Görev adı
private
boolean
recurrence
Recurrence
Görev tekrarlama ayrıntısı
recurrent
boolean
Tekrarlama
start
number
Başlangıç tarihi
state
string
Görev durumu adı. Görev farklı bir projeye taşınırken yeni projede farklı bir duruma geçiş yapılmak istendiğinde gereklidir.
steps
Checklist | ProgressBar
'stepType' değeri 'steps' veya 'progress' olduğunda gereklidir.
stepType
string
'none', 'steps' veya 'progress'
subtasks
string[]
Alt görevlerin ID listesi
workflowId
string
İş akış ID'si
Görev Sil
DELETE
https://cubicl.io/api/v1/tasks/:id
Path Parameters
id*
string
Görev ID'si
Göreve Alt Görev Ekle
POST
https://cubicl.io/api/v1/tasks/:id/subtasks
Path Parameters
id*
string
Görev ID'si
Request Body
subtask*
string
Alt görev olarak eklenmek istenen görevin ID'si.
Görev Durumunu Güncelle
PUT
https://cubicl.io/api/v1/tasks/:id/state
Görevin durumunu verilen durum ile değiştirir. Bir projenin varsayılan durumları; Bekliyor, Aktif, Tamamlandı ve Askıya Alındı durumlarıdır. Bu durumlar sistem tarafından sırasıyla cb_waiting
, cb_active
, cb_completed
ve cb_suspended
olarak kaydedilir. Varsayılan durumlar kullanılmak istendiğinde sistem tarafından kaydedilen karşılığı gönderilmelidir.
Path Parameters
id*
string
Görev ID'si
Request Body
value*
string
Yeni görev durumu adı.
Görev Gönderisi Oluştur
POST
https://cubicl.io/api/v1/tasks/:id/activities
Görevde gönderi oluşturur.
Path Parameters
id*
string
Görev ID'si
Request Body
content
string
Gönderi içeriği. 'content' veya 'fileIds' değerinin gönderilmesi gereklidir.
fileIds
string[]
Dosya ID'lerinin listesi. Dosya içeren bir gönderi oluşturmak için, gönderiyi oluşturmadan önce dosyaları yüklemeniz ve ID'lerini burada ayarlamanız gerekir. 'fileIds' veya 'content' değerinin gönderilmesi gereklidir.
mentions
Mention[]
Gönderide bahsedilen kullanıcıların listesi.
replyToId
string
Cevaplanmak istenen gönderinin ID'si.
Görev Gönderisinin Görünürlüğünü Değiştir
PUT
https://cubicl.io/api/v1/tasks/:taskId/activities/:activityId
Destek talepleri ve müşteri ile paylaştığınız görevlerde, gönderinizin görünürlüğünü portal müşteriniz için değiştirebilirsiniz. E-posta görevlerinde yer alan gönderiler görünür yapıldığında, gönderi e-posta olarak gönderilir.
Path Parameters
taskId*
string
Görev ID'si
activityId*
string
Görünürlüğü değiştirilmek istenilen aktivite ID'si
Request Body
value*
boolean
Gönderinin görünürlüğünü belirler. true
değeri görünür yapar, false
değeri ise görünürlüğü kaldırır.
Görev Aktivitelerini Getir
GET
https://cubicl.io/api/v1/tasks/:id/activities
Path Parameters
id*
string
Görev ID'si
Veriler
Görev
Bir görevin ayrıntıları.
Görev Adımları
Görevler, adımları veya genel ilerlemeyi belirtmek için bir kontrol listesine veya ilerleme çubuğuna sahip olabilir.
Tekrarlama
Görev Aktivitesi
Güncelleme, ilerleme eylemleri ve görevlerdeki mesajlar görev aktivitelerini oluşturur.
Görev Durumu
Varsayılan Görev Durumları
Görev durumları proje için özelleştirilmemişse, varsayılan durumlar kullanılır. Bu değerler, kullanıcı arayüzünde gösterildiğinde kullanıcının diline çevrilir.
cb_waiting
Bekliyor
cb_active
Aktif
cb_completed
Tamamlandı
cb_suspended
Askıya Alındı
Görev durumlarının özelleştirilip özelleştirilmediğini veya varsayılanların kullanılıp kullanılmadığını görmek için proje nesnesini kontrol edebilirsiniz.
Last updated
Was this helpful?