/ /

Organizaciones y equipos

Organizaciones

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Organizaciones y equipos

Organizaciones

Obtener una organización

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /orgs/{ORG-ID}

Parámetros de la ruta de solicitud

Elemento de ruta	Tipo	Descripción
ORG-ID	string	(Obligatorio.) El identificador único para el organización cuya información deseas recuperar.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Descripción

predeterminado

pretty

booleano

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

booleano

Indicador que indica si se debe envolver la respuesta en un sobre o no.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, establece envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

includeDeletedOrgs

booleano

Bandera que indica si el cuerpo de la respuesta contiene organizaciones eliminadas.

Ops Manager respeta el valor de este parámetro solo si el usuario que realiza la solicitud tiene un rol global.

Si se configura en true o se omite, los usuarios asignados a un rol global reciben proyectos eliminados en la respuesta. Si se establece en false o si el usuario no tiene un rol de dueño global, la respuesta no contiene organizaciones borradas.

true

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
ID	string	Identificador único para la organización.
isDeleted	booleano	Indica si la organización ha sido eliminada.
Nombre	string	Nombre de la organización.
enlaces	objeto arreglo	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/"

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 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

HTTP/1.1 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}

Respuesta del cuerpo

{
   "id" : "{ORG-ID}",
   "isDeleted": false,
   "links": [{
   }],
   "name" : "Customer Application Support"
}

Volver

Obtener todas las organizaciones

Obtener todos los proyectos