Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
segments
/
{segment_id}
Obtener un Segmento
curl --request GET \
  --url https://onboarding.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id} \
  --header 'Content-Type: <content-type>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser application/json.

​
X-Request-Id
string<uuid>

Identificador único usado para rastrear cada solicitud.

Path Parameters

​
organization_id
string<uuid>
required

Identificador único de la organización asociada al ledger.

​
ledger_id
string<uuid>
required

Identificador único del ledger asociado.

​
segment_id
string<uuid>
required

Identificador único del segmento que deseas consultar, eliminar o actualizar.

Response

Indica que la solicitud se realizó correctamente y la respuesta contiene los datos esperados.

​
id
string<uuid>

Identificador único del segmento.

​
organizationId
string<uuid>

Identificador único de la organización.

​
ledgerId
string<uuid>

Identificador único del ledger.

​
name
string

Nombre del segmento.

Maximum length: 256
​
status
object

Objeto que contiene información sobre el estado.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Marca de tiempo de creación (UTC).

​
updatedAt
string<date-time>

Marca de tiempo de la última actualización (UTC).

​
deletedAt
string<date-time> | null

Marca de tiempo de la eliminación lógica, si aplica (UTC).