Extremo de las notas

En la API de Reactor, las notas son anotaciones que se pueden añadir a determinados recursos. Las notas son esencialmente comentarios sobre sus respectivos recursos. El contenido de las notas no afecta al comportamiento de los recursos y se puede utilizar en varios casos de uso, entre los que se incluyen los siguientes:

  • Proporcionar información básica
  • Usarlas como listas de tareas pendientes
  • Pasar consejos sobre el uso de los recursos
  • Dar instrucciones a otros integrantes del equipo
  • Registrar el contexto histórico

El extremo /notes de la API de Reactor le permite administrar estas notas de forma programada.

Las notas se pueden aplicar a los siguientes recursos:

Estos seis tipos se conocen colectivamente como recursos “anotables”. Cuando se elimina un recurso anotable, también se eliminan sus notas asociadas.

NOTA

Para los recursos que pueden tener varias revisiones, cualquier nota debe crearse en la revisión actual (principal). No podrán adjuntarse a otras revisiones.

Sin embargo, las notas pueden seguirse leyendo desde las revisiones. En estos casos, la API devuelve solo las notas que existían antes de la creación de la revisión. Proporcionan una instantánea de las anotaciones tal y como estaban cuando se cortó la revisión. Por el contrario, leer las notas de la revisión actual (principal) devuelve todas sus notas.

Primeros pasos

El extremo utilizado en esta guía forma parte de la API de Reactor. Antes de continuar, consulte la guía de introducción para obtener información importante sobre cómo autenticarse en la API.

Recuperación de una lista de notas

Puede recuperar una lista de notas para un recurso añadiendo /notes a la ruta de una petición GET para el recurso en cuestión.

Formato de API

GET /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
Parámetro Descripción
RESOURCE_TYPE El tipo de recurso para el que recupera notas. Debe tener uno de los siguientes valores:
  • data_elements
  • extensions
  • libraries
  • properties
  • rule_components
  • rules
RESOURCE_ID El id del recurso específico cuyas notas desea enumerar.

Solicitud

La siguiente solicitud enumera las notas adjuntas a una biblioteca.

curl -X GET \
  https://reactor.adobe.io/libraries/LBcffea1a38c52408cae2398868625a12d/notes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Respuesta

Una respuesta correcta devuelve una lista de notas adjuntas al recurso especificado.

{
  "data": [
    {
      "id": "NTa40de8d76bfd4e40835830900ce83b7b",
      "type": "notes",
      "attributes": {
        "author_display_name": "John Smith",
        "author_email": "jsmith@example.com",
        "created_at": "2020-12-14T17:51:00.411Z",
        "text": "this is a note on a library"
      },
      "relationships": {
        "resource": {
          "links": {
            "related": "https://reactor.adobe.io/libraries/LBcffea1a38c52408cae2398868625a12d"
          },
          "data": {
            "id": "LBcffea1a38c52408cae2398868625a12d",
            "type": "libraries"
          }
        }
      },
      "links": {
        "resource": "https://reactor.adobe.io/libraries/LBcffea1a38c52408cae2398868625a12d",
        "self": "https://reactor.adobe.io/notes/NTa40de8d76bfd4e40835830900ce83b7b"
      }
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": null,
      "prev_page": null,
      "total_pages": 1,
      "total_count": 1
    }
  }
}

Búsqueda de una nota

Puede buscar una nota proporcionando su ID en la ruta de una petición GET.

Formato de API

GET /notes/{NOTE_ID}
Parámetro Descripción
NOTE_ID El id de la nota que desea buscar.

Solicitud

curl -X GET \
  https://reactor.adobe.io/notes/NT550b7a17ab304d49ba289a2978d673e5 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Respuesta

Una respuesta correcta devuelve los detalles de la nota.

{
  "data": {
    "id": "NT550b7a17ab304d49ba289a2978d673e5",
    "type": "notes",
    "attributes": {
      "author_display_name": "John Smith",
      "author_email": "jsmith@example.com",
      "created_at": "2020-12-14T17:51:10.316Z",
      "text": "this is a note on a property"
    },
    "relationships": {
      "resource": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8"
        },
        "data": {
          "id": "PR4537ac6f1f204ffd864ec47c4b27c2e8",
          "type": "properties"
        }
      }
    },
    "links": {
      "resource": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8",
      "self": "https://reactor.adobe.io/notes/NT550b7a17ab304d49ba289a2978d673e5"
    }
  }
}

Crear una nota

ADVERTENCIA

Antes de crear una nota nueva, tenga en cuenta que las notas no se pueden editar y la única forma de eliminarlas es eliminar el recurso correspondiente.

Puede crear una nota nueva añadiendo /notes a la ruta de una petición POST para el recurso en cuestión.

Formato de API

POST /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
Parámetro Descripción
RESOURCE_TYPE El tipo de recurso para el que crea una nota. Debe tener uno de los siguientes valores:
  • data_elements
  • extensions
  • libraries
  • properties
  • rule_components
  • rules
RESOURCE_ID El id del recurso específico para el que desea crear una nota.

Solicitud

La siguiente solicitud crea una nota nueva para una propiedad.

curl -X POST \
  https://reactor.adobe.io/properties/PRb25a704c0b7c4562835ccdf96d3afd31/notes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'Content-Type: application/json' \
  -d '{
        "data": {
          "type": "notes",
          "attributes": {
            "text": "this is a note on a property"
          }
        }
      }'
Propiedad Descripción
type (Obligatorio) El tipo de recurso que se actualiza. Para este extremo, el valor debe ser notes.
attributes.text (Obligatorio) El texto que contiene la nota. Cada nota está limitada a 512 caracteres Unicode.

Respuesta

Una respuesta correcta devolverá los detalles de la nota recién creada.

{
  "data": {
    "id": "NT550b7a17ab304d49ba289a2978d673e5",
    "type": "notes",
    "attributes": {
      "author_display_name": "John Smith",
      "author_email": "jsmith@example.com",
      "created_at": "2020-12-14T17:51:10.316Z",
      "text": "This is a note on a property"
    },
    "relationships": {
      "resource": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8"
        },
        "data": {
          "id": "PR4537ac6f1f204ffd864ec47c4b27c2e8",
          "type": "properties"
        }
      }
    },
    "links": {
      "resource": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8",
      "self": "https://reactor.adobe.io/notes/NT550b7a17ab304d49ba289a2978d673e5"
    }
  }
}

En esta página