Listagem de todas as tags de um locatário
Função
Essa API é usada para consultar as tags de todos os recursos de propriedade de um locatário em um projeto específico.
URI
GET /v2/{project_id}/dcs/tags
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
tags |
Array of Tag objects |
Lista de tag. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
key |
String |
Chave de etiqueta, que pode conter um máximo de 36 caracteres Unicode. |
values |
Array of strings |
Valor da tag. |
Código de estado: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Exemplos de solicitações
POST https://{dcs_endpoint}/v2/{project_id}/dcs/tags
Exemplo de respostas
Código de estado: 200
Consultado com sucesso todas as tags do locatário.
{ "tags" : [ { "values" : [ "value1", "value2" ], "key" : 1 }, { "values" : [ "value1", "value2" ], "key" : 2 } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Consultado com sucesso todas as tags do locatário. |
400 |
Pedido inválido. |
500 |
Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.