Endpoint “notes”

Nell’API di Reactor, le note sono annotazioni testuali che possono essere aggiunte ad alcune risorse. Le note sono essenzialmente commenti sulle rispettive risorse. Il contenuto delle note non ha alcun impatto sul comportamento delle risorse e può essere utilizzato per diversi casi d’uso, tra cui:

  • Informazioni di base
  • Elenchi di cose da fare
  • Consigli sull’utilizzo delle risorse
  • Istruzioni per altri membri del team
  • Contesto cronologico

L’endpoint /notes nell’API di Reactor consente di gestire queste note a livello di programmazione.

Le note possono essere aggiunte alle seguenti risorse:

Questi sei tipi sono noti collettivamente come risorse “che supportano le note”. Quando si elimina una risorsa che supporta le nota, vengono eliminate anche le relative note associate.

NOTA

Per le risorse che possono avere più revisioni, le note devono essere create nella revisione corrente (head). Non possono essere collegate ad altre revisioni.

Tuttavia, le note possono comunque essere lette da revisioni. In questi casi, l’API restituisce solo le note esistenti prima della creazione della revisione. Offrono un’istantanea delle annotazioni così come erano quando la revisione è stata tagliata. La lettura delle note della revisione corrente (head) restituisce invece tutte le note.

Introduzione

L’endpoint utilizzato in questa guida fa parte dell’API di Reactor. Prima di continuare, controlla la guida introduttiva per informazioni importanti su come eseguire l’autenticazione nell’API.

Recuperare un elenco di note

Per recuperare un elenco di note per una risorsa, aggiungi /notes al percorso di una richiesta GET per la risorsa in questione.

Formato API

GET /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
Parametro Descrizione
RESOURCE_TYPE Tipo di risorsa di cui si devono recuperare le note. Deve essere uno dei seguenti valori:
  • data_elements
  • extensions
  • libraries
  • properties
  • rule_components
  • rules
RESOURCE_ID id della risorsa specifica di cui desideri elencare le note.

Richiesta

Con la richiesta seguente vengono elencate le note associate a una libreria.

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'

Risposta

In caso di esito positivo, la risposta restituisce un elenco di note associate alla risorsa specificata.

{
  "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
    }
  }
}

Cercare una nota

Per cercare una nota occorre specificare il relativo ID nel percorso di una richiesta GET.

Formato API

GET /notes/{NOTE_ID}
Parametro Descrizione
NOTE_ID id della nota da cercare.

Richiesta

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'

Risposta

In caso di esito positivo, la risposta restituisce i dettagli della 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"
    }
  }
}

Creare una nota

AVVERTENZA

Prima di creare una nuova nota, tieni presente che le note non sono modificabili e che l’unico modo per eliminarle consiste nell’eliminare la risorsa corrispondente.

Per creare una nuova nota, aggiungi /notes al percorso di una richiesta POST per la risorsa in questione.

Formato API

POST /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
Parametro Descrizione
RESOURCE_TYPE Tipo di risorsa per cui si sta creando una nota. Deve essere uno dei seguenti valori:
  • data_elements
  • extensions
  • libraries
  • properties
  • rule_components
  • rules
RESOURCE_ID id della risorsa specifica per la quale desideri creare una nota.

Richiesta

La richiesta seguente crea una nuova nota per una proprietà.

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"
          }
        }
      }'
Proprietà Descrizione
type (Obbligatorio) Tipo di risorsa da aggiornare. Per questo endpoint, il valore deve essere notes.
attributes.text (Obbligatorio) Testo della nota. Ogni nota può contenere un massimo di 512 caratteri Unicode.

Risposta

In caso di esito positivo, la risposta restituisce i dettagli della nota appena creata.

{
  "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"
    }
  }
}

In questa pagina