Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
segments
/
{segment_id}
Recuperar un Segmento
curl --request GET \
  --url https://ledger.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": "<unknown>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Encabezados

​
Authorization
string

El token de autorización. Este encabezado es requerido si su entorno tiene el Access Manager habilitado.

​
Content-Type
string
requerido

El tipo de medio del recurso. Debe ser application/json.

​
X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Parámetros de ruta

​
organization_id
string
requerido

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
requerido

The unique identifier of the associated Ledger.

​
segment_id
string<uuid>
requerido

The unique identifier of the segment that you want to retrieve, delete or update.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

​
id
string<uuid>

El identificador único del Segmento.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

El identificador único del Ledger.

​
name
string

The name of the Segment.

Maximum string length: 256
​
status
any
​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).