Conceptos básicos de API de Adobe Workfront Planning

El objetivo de la API de Planning de Adobe Workfront es simplificar la creación de integraciones con Planning mediante la introducción de una arquitectura REST-ful que funcione a través de HTTP. En este documento se da por hecho que está familiarizado con las respuestas de REST y JSON y se describe el método que utiliza la API de Planning.

Una familiaridad con el esquema de Workfront Planning le ayudará a comprender las relaciones de la base de datos que se pueden utilizar para extraer datos de Workfront Planning con fines de integración.

Puede llamar a la API de Planning desde un campo de búsqueda externa en un formulario personalizado de Workfront.

Para obtener más información sobre los campos de búsqueda externa, vea Ejemplos del campo de búsqueda externa en un formulario personalizado.

URL de API de Workfront Planning

Operaciones

Los objetos se manipulan enviando una solicitud HTTP a su URI único. La operación que se va a realizar se especifica mediante el método HTTP.

Los métodos HTTP estándar corresponden a las siguientes operaciones:

Para obtener más detalles y ejemplos de cada operación, consulte la documentación para desarrolladores de API de Workfront Planning.

Tipos de campo y modificadores de búsqueda utilizados con ellos

Puede utilizar modificadores y filtros con campos para controlar qué datos se devolverán en los resultados.

Uso de modificadores de búsqueda

Workfront Planning admite los siguientes modificadores de búsqueda:

Tipos de campo

A continuación se muestra la lista de tipos de campo admitidos y los modificadores de búsqueda que se pueden utilizar con cada uno de esos tipos de campo

Uso de las instrucciones "And" y "Or"

En la llamada de API puede tener filtros basados en varios criterios combinados por instrucciones $and" y "$or"

{
  "recordTypeId": "recordTypeId",
  "offset": "integer",
  "limit": "integer",
  "filters": [
    {
      "$or": [
        {
          "launch_date": {
            "$isBetween": [
              "2024-03-31T20:00:00.000Z",
              "2024-04-01T20:00:00.000Z"
            ]
          }
        },
        {
          "$and": [
            {
              "launch_date": {
                "$isBetween": [
                  "2024-03-31T20:00:00.000Z",
                  "2024-04-01T20:00:00.000Z"
                ]
              }
            },
            {
              "status": "active"
            }
          ]
        },
        {
          "$and": [
            {
              "launch_date": {
                "$isBetween": [
                  "2024-04-15T00:00:00.000Z",
                  "2024-04-16T00:00:00.000Z"
                ]
              }
            },
            {
              "status": "planned"
            }
          ]
        }
      ]
    }
  ]
}

Uso del parámetro de solicitud de campos

Puede utilizar el parámetro de solicitud de campos para especificar una lista separada por comas de campos específicos que se deben devolver. Estos nombres de campo distinguen entre mayúsculas y minúsculas.

Por ejemplo, la solicitud de

/v1/records/search?attributes=data,createdBy

{
    "records": [
        {
            "id": "Rc6527ecb35df57c441d92ba00",
            "createdBy": "61a9cc0500002f9fdaa7a6f824f557e1",
            "createdAt": null,
            "updatedBy": null,
            "updatedAt": null,
            "customerId": null,
            "imsOrgId": null,
            "recordTypeId": null,
            "data": {
                "F666c0b58b6fee61a2ea6ea81": [
                    {
                        "externalId": null,
                        "id": "Rc665728ff95730b58bc757b13",
                        "value": null
                    },
....

devuelve una respuesta similar a la siguiente:

{
    "priority": 2,
    "name": "first task",
    "ID": "4c7c08fa0000002ff924e298ee148df4",
    "plannedStartDate": "2010-08-30T09:00:00:000-0600"
}

Ordenar los resultados de las consultas en la API

Puede ordenar los resultados por cualquier campo si anexa lo siguiente a la llamada de API:

/v1/records/search

Cuerpo de la solicitud:

{
    "recordTypeId": "Rt6527ecb25df57c441d92b9fa",
    "filters": [],
    "sorting": [
        {
            "fieldId": "F6527ecb25df57c441d92b9fc",
            "direction": "asc"
        },
        {
            "fieldId": "F658afcbd4a0273c67c346fd5",
            "direction": "desc"
        }
    ],
    "limit": 500,
    "offset": 0,
    "rowOrderViewId": "V6527ecb75df57c441d92ba03",
    "groupingFieldIds": []
}

Límites de consultas y respuestas paginadas

De forma predeterminada, las solicitudes de API de Planning devuelven 500 resultados, empezando desde el principio de la lista. Para anular la limitación predeterminada del número de resultados, puede usar el parámetro limit en sus solicitudes y establecerlo en un número diferente, hasta 2000 resultados.

Le recomendamos que considere la posibilidad de utilizar respuestas paginadas para conjuntos de datos grandes agregando el parámetro offset a sus solicitudes. Las respuestas paginadas le permiten especificar la ubicación del primer resultado que se debe devolver.

Por ejemplo, si desea devolver los resultados 2001-4000, puede utilizar la siguiente solicitud. Este ejemplo devuelve 2000 registros que están en estado activo, a partir del resultado 2001:

POST /v1/records/search

Cuerpo de la solicitud:

{
    "recordTypeId": "recordTypeId",
    "offset": "2001",
    "limit": "2000",
    "filters": [
        { "status": "active" }
    ]
}

Para asegurarse de que los resultados estén correctamente paginados, utilice un parámetro de ordenación. Esto permite que los resultados se devuelvan en el mismo orden, para que la paginación no se repita ni omita resultados.

Para obtener más información sobre la ordenación, vea Ordenar resultados de consultas en la API en este artículo.