APIs für berechnete Attribute - Amazon Connect

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

APIs für berechnete Attribute

Sie können die folgenden Customer-Profiles-APIs für berechnete Attribute verwenden:

CreateCalculatedAttributeDefinition

CreateCalculatedAttributeDefinition

Erstellen eines neuen berechneten Attributs. Hierfür ist ein vorhandener Objekttyp in der Domain erforderlich. Sie können Attribute, die Sie aus einem einzelnen Quellobjekt abrufen möchten sowie die mathematischen Operationen, die insgesamt angewendet werden sollen, den Zeitraum und die Anzahl der Objekte definieren.

Nach der Erstellung werden neue Objektdaten, die in Customer Profiles aufgenommen werden, in das berechnete Attribut mit einbezogen, das dann mithilfe der GetCalculatedAttributeForProfile-API für ein Profil abgerufen werden kann. Sobald ein berechnetes Attribut definiert wurde, wird es für alle Profile innerhalb einer Domain verfügbar. Jedes berechnete Attribut kann nur auf ein ObjectType und höchstens zwei Felder aus diesem Feld verweisen ObjectType.

Anforderung

POST /domains/DomainName/calculated-attributes/CalculatedAttributeName
                            

{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE",
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
     },
     "Tags": {}
}

Antwort


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Anforderungstext

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • DisplayName

    Der Anzeigename des berechneten Attributs.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Erforderlich: Nein

  • Beschreibung

    Die Beschreibung des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Höchstlänge = 1 000 Zeichen.

    • Erforderlich: Nein

  • AttributeDetails

    Einzelheiten zu den in der Definition verwendeten Attributen und den mathematischen Operationen zwischen den Attributen. Beachten Sie die folgenden Komponenten:

    • Attribute

      Eine Liste von Attributelementen, die im mathematischen Ausdruck angegeben sind.

      • AttributeItem

        Die Details zu einem einzelnen Attributelement, das im mathematischen Ausdruck angegeben ist.

        • Name

          • Der Name eines Attributs, das in einem Profilobjekttyp definiert ist.

          • Typ: Zeichenfolge

    • Expression

      Mathematischer Ausdruck, der für Attributelemente in der Attributliste ausgeführt wird. Jedes Element im Ausdruck sollte der Struktur von\ "{folgenObjectTypeName. AttributeName}\“.

      • Beispiel: {ObjA.AttributeA} - {ObjA.AttributeB}

      • Typ: Zeichenfolge

      • Wir unterstützen ausschließlich die folgenden mathematischen Operationen: + - * /

      • Nach der Erstellung einer berechneten Attributdefinition kann der Ausdruck nicht mehr geändert werden

  • Bedingungen

    Definiert die Kriterien und den Schwellenwert für die Aggregation von berechneten Attributen.

    • Typ: Bedingungsobjekt

      • Bereich

      • ObjectCount

      • Threshold

  • Bereich

    Der relative Zeitraum, während dem Daten in der Aggregation berücksichtigt werden.

    • Typ: Range-Objekt

      • Wert: Der Zeitraum für die angegebenen Einheiten

      • Einheit: Zeiteinheit

        • Gültige Werte: Tage

    • Erforderlich: Ja

    • Anfänglicher Geltungsbereich: Maximal 366 Tage

  • ObjectCount

    Die Anzahl der für das berechnete Attribut verwendeten Profilobjekte.

    • Typ: Zahl

    • Range: 1 bis 100

    • Erforderlich: Nein

  • Threshold

    Die Vergleichslogik zur Generierung eines berechneten Attributs „true/false“.

    • Typ: Threshold-Objekt

      • Wert

        • Der Schwellenwert.

        • Typ: Zeichenfolge

        • Erforderlich: Nein

      • Operator

        • Der Operator des Schwellenwerts

        • Typ: ENUM

        • Zulässige Werte:

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NOT_EQUAL_TO

    • Erforderlich: Nein

  • Statistik

    Der für das berechnete Attribut auszuführende Aggregationsvorgang.

    • Typ: ENUM

    • Zulässige Werte:

      • FIRST_OCCURRENCE

      • LAST_OCCURRENCE

      • COUNT

      • SUM

      • MINIMUM

      • MAXIMUM

      • AVERAGE

      • MAX_OCCURRENCE

UpdateCalculatedAttributeDefinition

UpdateCalculatedAttributeDefinition

Aktualisieren der Definition eines berechneten Attributs. Aktualisierungen sind auf den Anzeigenamen, die Beschreibung, den Zeitraum, die Anzahl der Objekte und den Schwellenwert beschränkt. Diese API unterstützt teilweise Aktualisierungen, sodass nur die zu aktualisierenden Parameter gesendet werden.

Beachten Sie, dass bei einer Aktualisierung der Bedingungen eine Erhöhung des Datumsbereichs eines berechneten Attributs keine Berücksichtigung historischer Daten außerhalb des aktuellen Datumsbereichs auslöst.

Anforderung

PUT /domains/DomainName/calculated-attributes/CalculatedAttributeName
                            

{
    "DisplayName": "string",
    "Description": "string",
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
   }
}

Antwort


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Anforderungstext

  • DisplayName

    Der Anzeigename des berechneten Attributs.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Erforderlich: Nein

  • Beschreibung

    Die Beschreibung des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Höchstlänge = 1 000 Zeichen.

    • Erforderlich: Nein

  • Bedingungen

    Definiert die Kriterien und den Schwellenwert für die Aggregation von berechneten Attributen.

    • Typ: Bedingungsobjekt

      • Bereich

      • ObjectCount

      • Threshold

  • Bereich

    Der relative Zeitraum, während dem Daten in der Aggregation berücksichtigt werden.

    • Typ: Range-Objekt

      • Wert: Der Zeitraum für die angegebenen Einheiten

      • Einheit: Zeiteinheit

        • Gültige Werte: Tage

    • Erforderlich: Ja

    • Anfänglicher Geltungsbereich: Maximal 366 Tage

  • ObjectCount

    Die Anzahl der für das berechnete Attribut verwendeten Profilobjekte.

    • Typ: Zahl

    • Range: 1 bis 100

    • Erforderlich: Nein

  • Threshold

    Die Vergleichslogik zur Generierung eines berechneten Attributs „true/false“.

    • Typ: Threshold-Objekt

      • Wert

        • Der Schwellenwert.

        • Typ: Zeichenfolge

        • Erforderlich: Nein

      • Operator

        • Der Operator des Schwellenwerts

        • Typ: ENUM

        • Zulässige Werte:

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NOT_EQUAL_TO

    • Erforderlich: Nein

GetCalculatedAttributeDefinition

GetCalculatedAttributeDefinition

Abrufen der Definition eines berechneten Attributs.

Anforderung

GET /domains/DomainName/calculated-attributes/CalculatedAttributeName

Anforderungstext

The request does not have a request body.

Antwort


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

URI-Anfrageparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

DeleteCalculatedAttributeDefinition

DeleteCalculatedAttributeDefinition

Löschen der Definition eines vorhandenen berechneten Attributs. Das Löschen eines berechneten Standardattributs ist zwar möglich, jedoch kann dieser Vorgang nicht rückgängig gemacht werden. Sie müssten das Attribut mithilfe der CreateCalculatedAttributeDefinition-API bei Bedarf selbst neu erstellen.

Anforderung

DELETE /domains/DomainName/calculated-attributes/CalculatedAttributeName

Anforderungstext

The request does not have a request body.

Antwort

The response does not have a response body.

URI-Anfrageparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

ListCalculatedAttributeDefinitions

ListCalculatedAttributeDefinitions

Abrufen aller berechneten Attributdefinitionen für eine Domain.

Anforderung

GET /domains/DomainName/calculated-attributes?max-results=MaxResults&next-token=NextToken

Anforderungstext

The request does not have a request body.

Antwort


{
    "Items": [
        {
            "CalculatedAttributeName": "string",
            "DisplayName": "string",
            "Description": "string",
            "CreatedAt": "timestamp",
            "LastUpdatedAt": "timestamp"
        },
        ...
    ],
    "NextToken": "string"
}

URI-Anfrageparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • MaxResults

    Die maximale Anzahl der zurückgegebenen Objekte pro Seite.

    • Gültiger Bereich: Mindestwert 1. Maximalwert 100

  • NextToken

    Das Paginierungstoken aus dem vorherigen ListCalculatedAttributeDefinition API-Aufruf.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Höchstlänge = 1 024 Zeichen.

GetCalculatedAttributeForProfile

GetCalculatedAttributeForProfile

Initiiert die Berechnung und ruft das Ergebnis eines einzelnen berechneten Attributs für ein einzelnes Profil ab.

Anforderung

GET /domains/DomainName/profile/ProfileId/calculated-attributes/CalculatedAttributeName

Anforderungstext

The request does not have a request body.

Antwort


{
    "Name": "string",
    "DisplayName": "string",
    "Value": "string",
    "IsDataPatrial": "string"
}

URI-Anfrageparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

ListCalculatedAttributesForProfile

ListCalculatedAttributesForProfile

Initiiert die Berechnung und ruft die Ergebnisse aller berechneten Attribute für ein einzelnes Profil ab.

Anforderung

GET /domains/DomainName/profile/ProfileId/calculated-attributes?max-results=MaxResults&next-token=NextToken

Anforderungstext

The request does not have a request body.

Antwort


{
    "Items": [
        {
            "CalculatedAttributeName": "string",
            "DisplayName": "string",
            "Value": "string",
            "IsDataPartial" : "string"
        },
        ...
    ],
    "NextToken": "string"
}

URI-Anfrageparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • ProfileId

    • Pattern: [a-f0-9]{32}

    • Erforderlich: Ja

  • MaxResults

    Die maximale Anzahl der zurückgegebenen Objekte pro Seite.

    • Gültiger Bereich: Mindestwert 1. Maximalwert 100

  • NextToken

    Das Paginierungstoken aus dem vorherigen ListCalculatedAttributeDefinition API-Aufruf.

    • Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Höchstlänge = 1 024 Zeichen.