Snapshot - Update
Atualize as informações de um instantâneo. Apenas a subscrição de origem que tirou o instantâneo pode atualizar o instantâneo.
PATCH {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com). |
snapshot
|
path | True |
string uuid |
ID que referencia um instantâneo específico. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
applyScope |
string[] |
Matriz dos IDs da subscrição Face de destino para o instantâneo, especificados pelo utilizador que criou o instantâneo ao chamar Snapshot - Take. Para cada instantâneo, apenas as subscrições incluídas no applyScope of Snapshot - Take podem aplicá-lo. |
userData |
string |
O utilizador especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder os 16 KB. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Uma chamada bem-sucedida devolve um corpo de resposta vazio. |
|
Other Status Codes |
Resposta de erro. |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
Exemplos
Update snapshot example
Pedido de amostra
PATCH {Endpoint}/face/v1.0-preview/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc
{
"applyScope": [
"64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
],
"userData": "User-provided data attached to the snapshot."
}
Resposta da amostra
Definições
Name | Description |
---|---|
APIError |
Informações de erro devolvidas pela API |
Error |
Corpo do erro. |
Update |
Corpo do pedido para atualizar um instantâneo, com uma combinação de âmbito de aplicação definido pelo utilizador e dados especificados pelo utilizador. |
APIError
Informações de erro devolvidas pela API
Name | Tipo | Description |
---|---|---|
error |
Corpo do erro. |
Error
Corpo do erro.
Name | Tipo | Description |
---|---|---|
code |
string |
|
message |
string |
UpdateSnapshotRequest
Corpo do pedido para atualizar um instantâneo, com uma combinação de âmbito de aplicação definido pelo utilizador e dados especificados pelo utilizador.
Name | Tipo | Description |
---|---|---|
applyScope |
string[] |
Matriz dos IDs da subscrição Face de destino para o instantâneo, especificados pelo utilizador que criou o instantâneo ao chamar Snapshot - Take. Para cada instantâneo, apenas as subscrições incluídas no applyScope of Snapshot - Take podem aplicá-lo. |
userData |
string |
O utilizador especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder os 16 KB. |