URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Este endpoint não usa parâmetros de caminho de solicitação HTTP.
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | Descrição | Default |
| inteiro | Número da página (com base em 1). |
|
| inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
| booleano | Exibe a resposta em um formato de impressão bonita. |
|
| booleano | Especifica se deseja ou não envolver a resposta em um envelope. |
|
| string | Filtra os resultados com base no nome da organização especificado. Executa uma pesquisa sem diferenciação de maiúsculas e minúsculas para organizações que correspondem exatamente ao Por exemplo, se você especificar um parâmetro de query | none |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
documento de resposta
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Nome | Tipo | Descrição |
|---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| array | A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web. |
| número | Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado. |
results documento incorporado
Cada resultado é uma organização.
Nome | Tipo | Descrição |
|---|---|---|
id | string | Identificador único da organização. |
isDeleted | booleano | Sinalizador que indica se a organização foi excluída. |
name | string | Nome da organização. |
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
Exemplo de solicitação
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/"
Exemplo de resposta
Cabeçalho de resposta
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Corpo de resposta
{ "links" : [{ "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs", "rel" : "self" }], "results" : [ { "id" : "{ORG-ID1}", "isDeleted": false, "links": [{ }], "name" : "Internal Application Support" }, { "id" : "{ORG-ID2}", "isDeleted": false, "links": [{ }], "name" : "Customer Application Support" }, { "id" : "{ORG-ID3}", "isDeleted": false, "links": [{ }], "name" : "Research and Development" } ], "totalCount" : 3 }