Anteckningsslutpunkt
I Reaktors-API:t är anteckningar textanteckningar som du kan lägga till i vissa resurser. Anteckningar är i huvudsak kommentarer om deras respektive resurser. Innehållet i anteckningarna påverkar inte resursbeteendet och kan användas för en mängd olika användningsområden, bland annat följande:
- Ange bakgrundsinformation
- Fungerar som att göra-listor
- Skicka rådgivning om resursanvändning
- Ge instruktioner till andra teammedlemmar
- Inspelningshistorik
Med slutpunkten /notes
i Reaktors API kan du hantera anteckningarna programmatiskt.
Anteckningar kan användas med följande resurser:
Dessa sex typer kallas tillsammans för"betydande" resurser. När en anteckningsbar resurs tas bort, tas även tillhörande anteckningar bort.
Komma igång
Slutpunkten som används i den här guiden ingår i Reaktors-API. Innan du fortsätter bör du läsa kom igång-guiden för att få viktig information om hur du autentiserar dig för API:t.
Hämta en lista med anteckningar list
Du kan hämta en lista med anteckningar för en resurs genom att lägga till /notes
i sökvägen för en GET-förfrågan för den aktuella resursen.
API-format
GET /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
RESOURCE_TYPE
Den typ av resurs som du hämtar anteckningar för. Måste vara något av följande värden:
data_elements
extensions
libraries
properties
rule_components
rules
RESOURCE_ID
id
för den specifika resurs vars anteckningar du vill visa.Begäran
Följande begäran visar anteckningarna som är kopplade till ett bibliotek.
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'
Svar
Ett godkänt svar returnerar en lista med anteckningar som är kopplade till den angivna resursen.
{
"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
}
}
}
Söka efter en anteckning lookup
Du kan söka efter en anteckning genom att ange dess ID i sökvägen till en GET-förfrågan.
API-format
GET /notes/{NOTE_ID}
NOTE_ID
id
av anteckningen som du vill söka efter.Begäran
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'
Svar
Ett godkänt svar returnerar informationen i anteckningen.
{
"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"
}
}
}
Skapa en anteckning create
Du kan skapa en ny anteckning genom att lägga till /notes
i sökvägen för en POST-förfrågan för resursen i fråga.
API-format
POST /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
RESOURCE_TYPE
Den typ av resurs som du skapar en anteckning för. Måste vara något av följande värden:
data_elements
extensions
libraries
properties
rule_components
rules
RESOURCE_ID
id
för den specifika resurs som du vill skapa en anteckning för.Begäran
Följande begäran skapar en ny anteckning för en egenskap.
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
Svar
Ett godkänt svar returnerar information om den nya anteckningen.
{
"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"
}
}
}