Consulta de projetos empresariais
Função
Essa API é usada para consultar projetos empresariais. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/enterprise-projects
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
Integer |
Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo. |
limit |
Não |
Integer |
Número de registros a serem consultados. O valor padrão é 100. o valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valor:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
enterprise_projects |
Array of EnterpriseProjectItem objects |
Informações do projeto empresarial. |
total_count |
Integer |
Número total de projetos empresariais. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do projeto empresarial. |
name |
String |
Nome do projeto empresarial. |
description |
String |
Descrição. |
status |
String |
Status.
|
created |
String |
Tempo de criação no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. |
updated |
String |
Hora de atualização no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Consulta de projetos empresariais
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/enterprise-projects
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "total_count" : 4, "enterprise_projects" : [ { "id" : 0, "name" : "default", "description" : null, "status" : 1, "created" : null, "updated" : null }, { "id" : "5c7d11e0-3201-4558-bcce-1172137cf7e2", "name" : "sjw-eps", "description" : null, "status" : 1, "created" : "2023-06-12T02:14:28+0000", "updated" : "2023-06-12T02:14:28+0000" }, { "id" : "12093327-28dc-46c5-8ba6-d42c9236f9d6", "name" : "adf", "description" : null, "status" : 1, "created" : "2023-05-06T08:33:03+0000", "updated" : "2023-05-06T08:33:03+0000" }, { "id" : "07d90b3f-422b-40c9-b9b3-6d00d1d7a60b", "name" : "eps-test", "description" : null, "status" : 1, "created" : "2023-03-16T01:38:13+0000", "updated" : "2023-03-16T01:38:13+0000" } ] }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.