Récupération des enregistrements

Lorsqu'un seul ID est spécifié, la réponse est { data: {object} }. Lorsque plusieurs ID sont spécifiés, la réponse est { data: [{object1}, {object2}, … {objectn}] }.

Vous pouvez interroger un maximum de 10 identifiants simultanément. Les clés de propriété et leur signification sont répertoriées dans la documentation de référence des propriétés de l'API, disponible dans votre compte Celoxis.

Pour récupérer une tâche avec l'ID 123 :

curl -g -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: bearer YourTokenHere' \ 'https://app.celoxis.com/psa/api/v2/tasks/123'

Pour récupérer les tâches dont les identifiants sont 123, 456 et 789 :

curl -g -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: bearer YourTokenHere' \ 'https://app.celoxis.com/psa/api/v2/tasks/123,456,789'

Récupération des tâches incluant les champs de référence et de valeur acquise dans une requête de liste :

curl -g -X GET \ -H 'Authorization: bearer YourTokenHere' \ -G --data-urlencode 'fields=["id","name","baselineStart","cpi","spi"]' \ 'https://app.celoxis.com/psa/api/v2/tasks'

Les requêtes de liste fonctionnent comme des rapports dans Celoxis : vous pouvez filtrer, trier et paginer les résultats.

La réponse est un objet JSON au format suivant : { data: [{object1}, {object2}, … {objectN}], totalRecords: M, nextPage: Z } où totalRecords est le nombre total d’enregistrements renvoyés par la requête et nextPage est le numéro de la page suivante d’enregistrements s’il y a plus de données à récupérer.

Transmettez un objet JSON comme « filter » à la requête API. Chaque clé correspond à une propriété et chaque valeur au filtre associé à cette propriété. Ce filtre récupère les tâches suivantes :

{ "name": "^5", "custom_city": [ "Chicago", "New York" ], "project.deadline": "Le mois prochain", "project.custom_bid": "Gagné" }

Le filtre ci-dessus récupérera les tâches dont : 1) le nom commence par 5 ; 2) l’attribut personnalisé « Ville » (clé de formule « city ») est Chicago ou New York ; 3) la date limite du projet est le mois prochain ; et 4) le champ personnalisé du projet (clé de formule « bid ») a la valeur « Gagné ». Les clés de propriété sont répertoriées dans la documentation de référence de l’API de votre compte Celoxis.

Pour trier les résultats, transmettez `sort` à la requête API. Utilisez une liste de clés de champ séparées par des virgules. Ajoutez ` /desc` à une clé pour la trier par ordre décroissant.

Par exemple, `/api/v2/tasks?sort=project.name,plannedStart /desc` trie les tâches par nom de projet, puis par date de début planifiée, par ordre décroissant. Les champs triables sont indiqués dans la documentation de référence des propriétés de l'API de votre compte Celoxis.

Une requête de liste renvoie au maximum 250 enregistrements. Pour récupérer une page ultérieure, transmettez le paramètre page dans la requête API, par exemple /api/v2/tasks?page=2.

Par défaut, la plupart des colonnes sont renvoyées. Les champs de référence et de valeur acquise (tels que baselineStart, baselineFinish, cpi, spi et les indicateurs associés) sont exclus des réponses de type liste, sauf si vous les demandez explicitement avec l'option `fields`. Pour ne renvoyer que les colonnes nécessaires, transmettez `fields` comme paramètre de requête : un tableau JSON contenant les clés des champs. Cette méthode fonctionne aussi bien pour les requêtes de type liste que pour la récupération par ID. Les `id` et `url` sont toujours incluses.

Les clés de champ sont répertoriées dans la documentation de référence des propriétés de l'API de votre compte Celoxis. Pour la plupart des colonnes, utilisez la clé telle qu'indiquée. Pour les colonnes d'association (comme Utilisateur ou Projet dans une entrée de temps), la table utilise `__data_` comme séparateur. Dans le `fields` , remplacez `__data_` par un point : par exemple, `user.name` au lieu de `user.__data_name`. La réponse utilise toujours la clé la plus courte (par exemple, `user`).

Pour inclure les données d'association au lieu du simple lien d'association, ajoutez les colonnes d'association dont vous avez besoin au des champs (par exemple user.name, project.name).

Récupérer les entrées de temps pour le projet 1234, en ne renvoyant que l'identifiant, la date, les heures, les commentaires, le code temporel, l'état, ainsi que les détails de l'utilisateur et du projet :

curl -g -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: bearer YourTokenHere' \ -G --data-urlencode 'fields=["id","date","hours","comments","timeCode","state","user.name","project.name"]' \ --data-urlencode 'filter={"project.id":"1234"}' \ 'https://app.celoxis.com/psa/api/v2/timeEntries'

Récupérez la deuxième page des tâches dont le nom commence par Joy, y compris le nom du projet et la date limite :

curl -g -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: bearer YourTokenHere' \ -G --data-urlencode 'filter={"name":"^Joy","project.deadline":"Next Week"}' \ --data-urlencode 'fields=["id","name","project.name","project.deadline"]' \ 'https://app.celoxis.com/psa/api/v2/tasks?page=2'

Pour obtenir les détails des associations d'une entité :

Récupérer tous les prédécesseurs d'une tâche dont l'ID est 12345 :

curl -g -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: bearer YourTokenHere' \ 'https://app.celoxis.com/psa/api/v2/tasks/12345/predecessors'