Embedding

Übersicht

Einbindung erstellen

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/embedding

Methode: POST

Query:

• {clientId}: string – Die ID eines CCM19-Kundenkontos
• {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist

Payload: Embedding

Response:

• 201 – Ressource erfolgreich erzeugt
• Embedding
• 400 – Ungültige oder fehlende Eigenschaften

Alle Einbindungen auslesen

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/embedding

Methode: GET

Query:

• {clientId}: string – Die ID eines CCM19-Kundenkontos
• {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist

Response:

• 200 – Erfolg
• Embedding[]

Einbindung auslesen

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/embedding/{embeddingId}

Methode: GET

Query:

• {clientId}: string – Die ID eines CCM19-Kundenkontos
• {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist
• {embeddingId}: string – Die ID der zu behandelnden Ressource

Response:

• 200 – Erfolg
• Embedding
• 404 – Ressource nicht gefunden

Einbindung aktualisieren

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/embedding/{embeddingId}

Methode: PUT

Query:

• {clientId}: string – Die ID eines CCM19-Kundenkontos
• {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist
• {embeddingId}: string – Die ID der zu behandelnden Ressource

Payload: Embedding

Response:

• 200 – Erfolg
• Embedding
• 400 – Ungültige oder fehlende Eigenschaften
• 404 – Ressource nicht gefunden

Einbindung entfernen

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/embedding/{embeddingId}

Methode: DELETE

Query:

• {clientId}: string – Die ID eines CCM19-Kundenkontos
• {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist
• {embeddingId}: string – Die ID der zu behandelnden Ressource

Response:

• 204 – Ressource erfolgreich gelöscht
• 404 – Ressource nicht gefunden