Recuperación de registros

Cuando se especifica un solo ID, la respuesta es { data: {object} }. Cuando se especifican varios ID, la respuesta es { data: [{object1}, {object2}, … {objectn}] }.

Puedes consultar un máximo de 10 ID a la vez. Las claves de propiedad y lo que representan se enumeran en la Referencia de propiedades de la API en tu cuenta de Celoxis.

Para obtener una tarea con ID 123:

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

Para obtener las tareas con ID 123, 456 y 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'

Obtención de tareas que incluyen campos de valor base y valor ganado en una consulta de lista:

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'

Las consultas de lista funcionan como los informes en Celoxis: se pueden filtrar, ordenar y paginar los resultados.

La respuesta es un objeto JSON en el siguiente formato: { data: [{object1}, {object2}, … {objectN}], totalRecords: M, nextPage: Z } donde totalRecords es el número total de registros devueltos por la consulta y nextPage es el número de la siguiente página de registros si hay más datos para obtener.

Pase un objeto JSON como de filtro en la solicitud de API. Cada clave es una propiedad y cada valor es el filtro para esa propiedad. Este filtro recupera las siguientes tareas:

{ "name": "^5", "custom_city": [ "Chicago", "New York" ], "project.deadline": "El próximo mes", "project.custom_bid": "Ganador" }

El filtro anterior mostrará las tareas que cumplan con los siguientes criterios: 1) nombre inicial (5 ), 2) atributo personalizado Ciudad (clave de fórmula city) correspondiente a Chicago o Nueva York, 3) fecha límite del proyecto el próximo mes y 4) campo personalizado del proyecto (clave de fórmula bid) con valor Ganado. Las claves de propiedad se encuentran en la Referencia de propiedades de la API en su cuenta de Celoxis.

Para ordenar los resultados, pase `sort` como parámetro de consulta en la solicitud de API. Use una lista de claves de campo separadas por comas. Añada ` /desc` a una clave para ordenarla en orden descendente.

Por ejemplo, /api/v2/tasks?sort=project.name,plannedStart/desc ordena las tareas por nombre de proyecto y, a continuación, por fecha de inicio prevista, en orden descendente. Los campos que permiten la ordenación están marcados en la Referencia de propiedades de la API de su cuenta de Celoxis.

Una solicitud de lista devuelve como máximo 250 registros. Para obtener una página posterior, pase page en la solicitud de API, por ejemplo /api/v2/tasks?page=2.

Por defecto, se devuelven la mayoría de las columnas. Los campos de línea base y de valor ganado (como baselineStart, baselineFinish, cpi, spi y métricas relacionadas) se excluyen de las respuestas de lista a menos que se soliciten con fields. Para devolver solo las columnas necesarias, pase fields como parámetro de consulta: una matriz JSON de claves de campo. Esto funciona para consultas de lista y para la obtención por ID. Las id y url siempre se incluyen.

Las claves de campo se enumeran en la Referencia de propiedades de la API en su cuenta de Celoxis. Para la mayoría de las columnas, use la clave como se muestra. Para las columnas de asociación (como Usuario o Proyecto en una entrada de tiempo), esa tabla usa __data_ como separador. En el fields , reemplácelo con un punto, por ejemplo user.name en lugar de user.__data_name. La respuesta seguirá usando la clave más corta (por ejemplo, user).

Para incluir datos de asociación en lugar de solo el enlace de asociación, agregue las columnas de asociación que necesite a la de campos (por ejemplo, user.name, project.name).

Obtener registros de tiempo para el proyecto 1234, devolviendo solo id, fecha, horas, comentarios, código de tiempo, estado y detalles del usuario y del proyecto:

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'

Obtén la segunda página de tareas cuyo nombre comience con Joy, incluyendo el nombre del proyecto y la fecha límite:

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'

Para obtener detalles de las asociaciones de una entidad:

Obtener todos los predecesores de una tarea cuyo ID sea 12345:

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