Pular para o conteúdo principal

Obter um documento

GET 
/v1/data-entities/:entity_name/documents/:key

Retorna um documento anexado a uma entidade.

Request​

Path Parameters

    entity_name stringrequired

    Nome da entidade

    Example: motivos_de_cancelamento
    key stringrequired

    Chave/Nome do documento

    Example: dten_5f92f01728e009f403d8502e

Query Parameters

    fields string

    Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

    Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

    Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

    Examples:

    Retorna apenas os campos `id` e `createdAt`.

    Example: id,createdAt

    expand string

    Expande as referências.

    Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

    Example: data.loan

Responses​

Retorna o objeto Documents para uma entidade e chave válidas; para entidade ou documento excluído, retorna um subconjunto com deleted: true.

Schema

    id string

    Identificador exclusivo para o objeto.

    Example: doc_5f92f01728e009f403d8502e
    key string

    Chave/Nome que será dado ao documento

    Example: funcionario_desligado
    value object

    Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido

    Example: {}
    dataEntity string

    Id da entidade, ao qual o documento está relacionado

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z
    deleted boolean

    Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

    Default value: false
    Example: false

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice
Loading...