data-service
2023.10
false
- OpenAPI do Data Service
- Obter Registro de Entidade Por Id
- Obter registros de entidade
- Consultar Registros de Entidade
- Excluir Registro de Entidade por Id
- Atualizar Registro de Entidade por Id
- Criar Gravação de Entidade
- Criar Vários Registros de Entidade
- Atualizar Vários Registros de Entidade
- Excluir Vários Registros de Entidade
- Baixar arquivo do Campo de Registro
- Carregar Arquivo no Campo de Registro
- Excluir Arquivo do Campo de Registro
Guia da API do Data Service
Última atualização 5 de mai de 2026
Recupera um único registro de Entidade por ID.
Ponto de Extremidade da API

BaseURL/EntityService/<Entity>/read/{id}
- URL base:
https://{yourDomain}/{organizationName}/{tenantName}/dataservice_
Cabeçalhos de solicitação.
| Cabeçalho | Valor |
|---|---|
| Autorização | O portador <access_token> |
Observação:
Substitua todos os valores entre os colchetes angulares <...> por seus valores de caso de uso correspondentes.
O <access_token> é aquele que você recebeu quando autorizou o aplicativo externo. Ele fica disponível por 1 hora, então você precisa gerar um novo, ou solicitar um token de atualização.
Variáveis de caminho
| Variável de caminho | Tipo de dados | Description | Valor padrão |
|---|---|---|---|
| id (Required) | string | O ID do registro da entidade que você deseja recuperar do Data Service. | NA |
Parâmetros de Consulta
| Parâmetro de consulta | Tipo de dados | Description | Valor Padrão |
|---|---|---|---|
| Expansão (Opcional) | int32 | Especifica a profundidade dos registros relacionados a serem recuperados. O valor deste parâmetro pode ser 1, 2 ou 3. | 2 |
Resposta
200 OK
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:20:24.485Z",
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Logo": {
"Name": "string",
"Path": "string",
"Size": 0,
"Type": "string"
},
"Name": "string",
"Nations": 0,
"OlymipcsVersion": 0,
"OpeningDate": "2021-03-04",
"UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"UpdateTime": "2021-03-04T10:20:24.485Z"
}
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:20:24.485Z",
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Logo": {
"Name": "string",
"Path": "string",
"Size": 0,
"Type": "string"
},
"Name": "string",
"Nations": 0,
"OlymipcsVersion": 0,
"OpeningDate": "2021-03-04",
"UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"UpdateTime": "2021-03-04T10:20:24.485Z"
}
401 não autorizado
Você não tem autenticação para acessar o Data Service. Verifique se seu Assistente ou Robô está conectado a uma pasta moderna em sua conta.
403 Forbidden
Você não tem permissão para acessar a entidade, campo ou registro ou está usando um tipo de robô não compatível. Entre em contato com seu administrador para obter as permissões necessárias.