Read a batch of objects by internal ID, or unique property values
Recupere um lote de objetos de CRM por seus IDs internos ou valores exclusivos de propriedades. Este endpoint é útil para buscar vários objetos em uma única solicitação, o que pode ajudar a otimizar o desempenho e reduzir o número de chamadas à API necessárias. Você pode especificar se deseja incluir objetos arquivados na resposta.
Supported products
Supported products
Required Scopes
Required Scopes
Autorizações
The access token received from the authorization server in the OAuth 2.0 flow.
Parâmetros de caminho
O tipo de objeto do CRM a ser lido em lote, como contatos, empresas ou negócios.
Parâmetros de consulta
Indica se devem ser retornados apenas os resultados que foram arquivados. O padrão é falso.
Corpo
Especifica a entrada para a leitura de um lote de objetos do CRM, incluindo matrizes de IDs de objetos, nomes de propriedades solicitadas (com histórico opcional) e uma propriedade de identificação exclusiva opcional.
Uma matriz de objetos SimplePublicObjectId, cada um contendo um ID de um objeto a ser lido.
Uma matriz de strings que representam as propriedades a serem retornadas na resposta para cada objeto.
Uma matriz de strings que indica as propriedades para as quais os valores históricos devem ser retornados, juntamente com os valores atuais.
Uma string que especifica o nome de uma propriedade cujos valores são únicos para o tipo de objeto, usada para identificar os objetos.
Resposta
successful operation
Um objeto de resposta em lote de objeto público
A data e hora em que a operação em lote foi concluída, no formato ISO 8601.
Uma matriz de itens SimplePublicObject que são o resultado da operação em lote.
A data e a hora em que a operação em lote foi iniciada, no formato ISO 8601.
O status atual da operação em lote. Os valores válidos incluem 'PENDENTE', 'PROCESSANDO', 'CANCELADO' e 'CONCLUÍDO'.
CANCELED, COMPLETE, PENDING, PROCESSING Um mapa de nomes de links para URIs associadas relacionadas à operação em lote.
A data e a hora em que a operação em lote foi solicitada, no formato ISO 8601.