Modifiche API di base: risposte alla ricerca di stato
Sono state apportate modifiche al modo in cui Workfront memorizza gli oggetti di stato. Queste modifiche non influiscono sul modo in cui vengono effettuate le richieste di ricerca dello stato, ma sulla risposta restituita dalle richieste API che includono una ricerca di oggetti stato restituendo un elenco incompleto di stati del gruppo.
Best practice
Per recuperare in modo affidabile l’elenco completo degli stati disponibili per un gruppo, le seguenti richieste sono considerate best practice.
Per Stato Gruppo Progetto:
Esempio:
/attask/api/<VERSION>/CSTEM/projectGroupStatuses?groupID=602d27640000bb3b779f770d5fb95d6d
Per lo stato del gruppo di task:
Esempio:
/attask/api/<VERSION>/CSTEM/taskGroupStatuses?groupID=602d27640000bb3b779f770d5fb95d6d
Per lo stato del gruppo di problemi:
Esempio:
/attask/api/<VERSION>/CSTEM/opTaskGroupStatuses?groupID=602d27640000bb3b779f770d5fb95d6d
Questi tre endpoint accettano includeHidden=true per recuperare gli stati nascosti di progetto/attività/problema di un determinato gruppo. La modellazione delle query di ricerca dello stato dopo questi esempi di best practice garantirà che tutte le informazioni sullo stato del gruppo siano incluse in ogni risposta.
Di seguito è riportato un esempio di query di ricerca stato eseguita su un gruppo di attività che include uno stato bloccato a livello di sistema Personalizzato_1 e uno stato sbloccato Personalizzato_2:
Esempio:
/attask/api/<VERSION>/CSTEM/taskGroupStatuses?groupID=602d286d000004fc8f53942de697a868
L’utilizzo di questo formato assicura che la risposta includa tutti i seguenti elementi:
{
"data": [
{
"color": "1C68FF",
"equatesWith": "NEW",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "New",
"objCode": "CSTEM",
"value": "NEW"
},
{
"color": "39FF39",
"equatesWith": "INP",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "In Progress",
"objCode": "CSTEM",
"value": "INP"
},
{
"color": "FF3939",
"equatesWith": "CPL",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "Complete",
"objCode": "CSTEM",
"value": "CPL"
},
{
"color": "8BC34A",
"equatesWith": "NEW",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "Custom_1",
"objCode": "CSTEM",
"value": "JET"
},
{
"color": "8BC34A",
"equatesWith": "NEW",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "Custom_2",
"objCode": "CSTEM",
"value": "OGC"
}
]
}
Informazioni sulle modifiche apportate alla query di ricerca dello stato legacy
Nel sistema legacy, una query di ricerca dello stato copia tutti gli stati di sistema disponibili per tutti i gruppi inclusi in una query. La risposta legacy includerebbe quindi tutti gli stati di sistema e gli stati a livello di gruppo disponibili per ciascun gruppo nella query.
Ad esempio, questa query (che non segue le best practice consigliate correnti):
Esempio:
/attask/api/<VERSION>/CSTEM/search?groupID=602d27640000bb3b779f770d5fb95d6d&enumClass=STATUS_TASK
Avrebbe la seguente risposta nel sistema legacy, che include tutti gli stati dell’oggetto:
{
"data": [
{
"color": "1C68FF",
"equatesWith": "NEW",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "New",
"objCode": "CSTEM",
"value": "NEW"
},
{
"color": "39FF39",
"equatesWith": "INP",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "In Progress",
"objCode": "CSTEM",
"value": "INP"
},
{
"color": "FF3939",
"equatesWith": "CPL",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "Complete",
"objCode": "CSTEM",
"value": "CPL"
},
{
"color": "8BC34A",
"equatesWith": "NEW",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "Custom_1",
"objCode": "CSTEM",
"value": "JET"
},
{
"color": "8BC34A",
"equatesWith": "NEW",
"groupID": "602d27640000bb3b779f770d5fb95d6d",
"label": "Custom_2",
"objCode": "CSTEM",
"value": "OGC"
}
]
}
Tuttavia, in seguito agli aggiornamenti apportati alla modalità di archiviazione e utilizzo degli stati, questi non vengono copiati per i gruppi e vengono ereditati da ciascun gruppo a livello di sistema. Di conseguenza, la query API di ricerca legge solo gli stati direttamente associati a un determinato gruppo, quindi la risposta include gli stati bloccati e sbloccati dal sistema, ma solo per i gruppi creati dopo l’aggiunta dello stato in questione.
Se non si utilizzano i metodi best practice aggiornati per eseguire query di ricerca dello stato dopo l’aggiornamento del sistema legacy, nella risposta verrà restituito un elenco incompleto degli stati dei gruppi.
Di seguito è riportato un esempio di ciò che questa struttura di richieste obsoleta restituisce dopo l’aggiornamento del sistema legacy:
Esempio:
/attask/api/<VERSION>/CSTEM/search?groupID=602d27640000bb3b779f770d5fb95d6d&enumClass=STATUS_TASK
Tieni presente che questa risposta include solo gli stati specifici del gruppo e non considera quelli dichiarati a livello di sistema:
{
"data": [
{
"color": "8BC34A",
"equatesWith": "NEW",
"groupID": "602d286d000004fc8f53942de697a868",
"label": "Custom_2",
"objCode": "CSTEM",
"value": "MMI"
}
]
}