Embedding

Overview

Create embedding

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

Method:POST

Query:

• {clientId}: string - The ID of a CCM19 client account
• {domainId}: string - The ID of a domain that exists in the client account

Payload:Embedding

Response:

• 201 - Resource successfully created
• Embedding
• 400 - Invalid or missing properties

Read all embeddings

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

Method:GET

Query:

• {clientId}: string - The ID of a CCM19 client account
• {domainId}: string - The ID of a domain that exists in the client account

Response:

• 200 - Success
• Embedding[]

Read embedding

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

Method:GET

Query:

• {clientId}: string - The ID of a CCM19 client account
• {domainId}: string - The ID of a domain that exists in the client account
• {embeddingId}: string - The ID of the resource to be handled

Response:

• 200 - Success
• Embedding
• 404 - Resource not found

Update embedding

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

Method:PUT

Query:

• {clientId}: string - The ID of a CCM19 client account
• {domainId}: string - The ID of a domain that exists in the client account
• {embeddingId}: string - The ID of the resource to be handled

Payload:Embedding

Response:

• 200 - Success
• Embedding
• 400 - Invalid or missing properties
• 404 - Resource not found

Remove embedding

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

Method:DELETE

Query:

• {clientId}: string - The ID of a CCM19 client account
• {domainId}: string - The ID of a domain that exists in the client account
• {embeddingId}: string - The ID of the resource to be handled

Response:

• 204 - Resource successfully deleted
• 404 - Resource not found