Notitie-eindpunt
In de Reactor-API zijn notities tekstuele annotaties die u aan bepaalde bronnen kunt toevoegen. Notities zijn hoofdzakelijk opmerkingen over hun respectieve middelen. De inhoud van notities is niet van invloed op het gedrag van bronnen en kan worden gebruikt voor verschillende gebruiksgevallen, zoals:
- Achtergrondinformatie opgeven
- Werken als-do lijsten
- Advies voor hulpbronnengebruik doorgeven
- Instructies geven aan andere teamleden
- Historische context opnemen
De /notes
Het eindpunt in Reactor API staat u toe om deze nota's programmatically te beheren.
De nota's kunnen de volgende middelen worden toegepast:
Deze zes types zijn collectief gekend als "opmerkelijke"middelen. Wanneer een opmerkelijke bron wordt verwijderd, worden de bijbehorende notities ook verwijderd.
Aan de slag
Het eindpunt dat in deze handleiding wordt gebruikt, maakt deel uit van de Reactor-API. Controleer voordat je doorgaat de gids Aan de slag voor belangrijke informatie over hoe te voor authentiek te verklaren aan API.
Een lijst met notities ophalen list
U kunt een lijst met notities voor een bron ophalen door deze toe te voegen /notes
op het pad van een GET-verzoek om de betrokken bron.
API-indeling
GET /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
RESOURCE_TYPE
Het type bron waarvoor u notities ophaalt. Moet een van de volgende waarden zijn:
data_elements
extensions
libraries
properties
rule_components
rules
RESOURCE_ID
id
van de specifieke bron waarvan u de notities wilt weergeven.Verzoek
In het volgende verzoek worden de notities weergegeven die aan een bibliotheek zijn gekoppeld.
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: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Antwoord
Een succesvolle reactie keert een lijst van nota's terug in bijlage aan het gespecificeerde middel.
{
"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
}
}
}
Een notitie opzoeken lookup
U kunt een nota opzoeken door zijn identiteitskaart in de weg van een verzoek van de GET te verstrekken.
API-indeling
GET /notes/{NOTE_ID}
NOTE_ID
id
van de notitie die u wilt opzoeken.Verzoek
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: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Antwoord
Als de reactie succesvol was, worden de details van de notitie geretourneerd.
{
"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"
}
}
}
Een notitie maken create
U kunt een nieuwe notitie maken door deze toe te voegen /notes
op het pad van een POST-aanvraag voor de betrokken bron.
API-indeling
POST /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
RESOURCE_TYPE
Het type bron waarvoor u een notitie maakt. Moet een van de volgende waarden zijn:
data_elements
extensions
libraries
properties
rule_components
rules
RESOURCE_ID
id
van de specifieke bron waarvoor u een notitie wilt maken.Verzoek
Met het volgende verzoek wordt een nieuwe notitie voor een eigenschap gemaakt.
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: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"type": "notes",
"attributes": {
"text": "this is a note on a property"
}
}
}'
type
notes
.attributes.text
Antwoord
Een succesvol antwoord retourneert de details van de nieuwe notitie.
{
"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"
}
}
}