Application de libellés d’accès aux flux de données sources

NOTE
  • Vous ne pouvez pas appliquer de libellés à une exécution de flux. Toutefois, les exécutions de flux héritent des libellés que vous appliquez au flux de données parent.

  • Si vous ne disposez pas d’un accès en lecture seule à un flux de données, vous ne pourrez pas non plus afficher ses exécutions de flux correspondantes.

Pour ajouter un libellé à un flux de données, envoyez une requête PATCH au point d’entrée /flows et indiquez l’identifiant du flux de données à mettre à jour.

Format d’API

PATCH /flows/{FLOW_ID}
ParamètreDescription
{FLOW_ID}Identifiant du flux de données à mettre à jour.

Requête

TIP
Pour effectuer une requête PATCH, indiquez la version/l’etag du flux de données que vous souhaitez mettre à jour comme paramètre d’en-tête if-match.

La requête suivante ajoute le libellé C12 au flux de données avec l’ID : 84224def-1e2a-4d95-9ea2-132d697ed2aa.

curl -X PATCH \
  'https://platform.adobe.io/data/foundation/flowservice/flows/84224def-1e2a-4d95-9ea2-132d697ed2aa' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -H 'if-match: "c5002e0e-0000-0200-0000-67a3c3b70000"'
  -d '[
    {
        "op": "add",
        "path": "/labels",
        "value": ["core/C12"]
    }
]'
PropriétéDescription
opAppel d’opération utilisé pour définir l’action nécessaire pour mettre à jour la connexion. Les opérations comprennent : add, replace et remove.
pathPartie du flux de données à mettre à jour.
valueNouvelle valeur avec laquelle vous souhaitez mettre à jour votre propriété.

Réponse

Une réponse réussie renvoie votre identifiant de flux et une balise dʼentité mise à jour. Vous pouvez vérifier la mise à jour en adressant une requête GET à l’API Flow Service et en y indiquant votre identifiant de flux.

{
    "id": "84224def-1e2a-4d95-9ea2-132d697ed2aa",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Une fois que vous avez correctement configuré les libellés d’accès à votre flux de données, tout utilisateur n’ayant pas accès à ce libellé ne pourra plus récupérer le flux de données. Par exemple, si un utilisateur qui n’est pas configuré avec le libellé C12 effectue une requête GET pour récupérer le flux de données avec l’ID : 84224def-1e2a-4d95-9ea2-132d697ed2aa, il recevra la réponse suivante :

{
    "type": "https://ns.adobe.com/aep/errors/FLOW-1439-404",
    "title": "Resource not found",
    "status": 404,
    "report": {
        "detailed-message": "The requested flows resource 84224def-1e2a-4d95-9ea2-132d697ed2aa is not found. Verify the resource ID before trying again.",
        "id": "84224def-1e2a-4d95-9ea2-132d697ed2aa",
        "request-id": "{REQUEST_ID}",
        "type": "flows"
    },
    "errorMessage": "The requested flows resource 84224def-1e2a-4d95-9ea2-132d697ed2aa is not found. Verify the resource ID before trying again.",
    "errorDetails": "The requested flows resource 84224def-1e2a-4d95-9ea2-132d697ed2aa is not found. Verify the resource ID before trying again."
}

De même, les utilisateurs et utilisatrices qui n’ont pas accès au libellé C12 ne pourront pas effectuer de requêtes PATCH ou DELETE par rapport au flux de données mis à jour et recevront la réponse suivante :

{
    "type": "https://ns.adobe.com/aep/errors/FLOW-2120-403",
    "title": "Forbidden",
    "status": 403,
    "report": {
        "detailed-message": "You do not have sufficient permissions to perform the operation. Please contact your administrator to resolve permissions and try again.",
        "request-id": "{REQUEST_ID}"
    },
    "errorMessage": "You do not have sufficient permissions to perform the operation. Please contact your administrator to resolve permissions and try again.",
    "errorDetails": "You do not have sufficient permissions to perform the operation. Please contact your administrator to resolve permissions and try again."
}