- 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
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Consultar Registros de Entidade
Consulta os registros da Entidade.
Cabeçalho |
Valor |
---|---|
Autorização |
Bearer
<access_token> |
Tipo de conteúdo |
application/json |
<...>
por seus valores de caso de uso correspondentes.
<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.
Parâmetro de consulta |
Tipo de dados |
Description |
Valor Padrão |
---|---|---|---|
expansionLevel (opcional) |
|
Especifica a profundidade dos registros relacionados a serem recuperados. O valor deste parâmetro pode ser 1, 2 ou 3. |
2 |
{
"selectedFields": [
"string"
],
"filterGroup": {
"logicalOperator": 0,
"queryFilters": [
{
"fieldName": "string",
"operator": "string",
"value": "string"
}
],
"filterGroups": [
null
]
},
"start": 0,
"limit": 0,
"sortOptions": [
{
"fieldName": "string",
"isDescending": true
}
]
}
{
"selectedFields": [
"string"
],
"filterGroup": {
"logicalOperator": 0,
"queryFilters": [
{
"fieldName": "string",
"operator": "string",
"value": "string"
}
],
"filterGroups": [
null
]
},
"start": 0,
"limit": 0,
"sortOptions": [
{
"fieldName": "string",
"isDescending": true
}
]
}
query
tem os seguintes componentes:
selectedFields
string
. Especifica a lista dos campos a serem retornados para cada registro da consulta. Se deixado em branco ou se a lista de consulta estiver vazia, todos os campos de registro serão retornados. O valor padrão é null
.
filterGroup
Este é um componente obrigatório que ajuda a definir as propriedades de filtragem para a consulta. Combina as seguintes propriedades:
- logicOperator - Esta é uma propriedade filterGroup opcional, do tipo
int32
. Ele especifica se todos os filtros e grupos de filtros se aplicam à consulta. Use0
para aplicar todos os filtros e grupos de filtros. Use1
para aplicar qualquer um dos filtros e grupos de filtros. O valor padrão é0
. -
queryFilter - Esta é uma propriedade filterGroup obrigatória, que ajuda a definir a expressão de filtragem. Tem as seguintes propriedades:
propriedade queryFilter
Tipo de dados
Description
fieldName
string
Especifica o nome do campo a ser filtrado.
operator
string
Especifica o operador de filtro. Suporta o seguinte:
contains
,not contains
,startswith
,endswith
,=
>
!=
<
,>=
, ,<=
,in
,not in
. Use o operador adequado para o tipo de campo correspondente.Value
string
Especifica o valor de filtragem.
- filterGroups - Esta é uma propriedade filterGroup opcional, caso seja necessário definir outra opção de filtragem para a consulta. Ele contém todas as propriedades filterGroup listadas acima.
Iniciar
int32
. Especifica o número de registros a serem ignorados antes de recuperar os registros da consulta. Pode ser usado junto com a propriedade limit para implementar a paginação. Os registros são ordenados de forma ascendente por seus IDs. Para modificar a ordem de classificação, use a propriedade sortOptions . O valor padrão é 0
.
limit
int32
. Especifica o número máximo de registros a serem lidos da entidade. Pode ser usado junto com a propriedade start para implementar a paginação. O valor padrão é 100
e o valor máximo é 1000
.
sortOptions
Este é um componente opcional, que ajuda a classificar os registros consultados por uma lista de campos. Se deixados em branco, os registros serão classificados em ordem crescente por seus IDs. Combina as seguintes propriedades:
- fieldName - Esta é uma propriedade sortOptions obrigatória, do tipo
string
. Ele especifica o nome do campo usado para classificar os registros. O nome deve corresponder a um campo válido e diferencia maiúsculas de minúsculas. - isDescending - Esta é uma propriedade sortOptions opcional, do tipo
boolean
. Defina-o comotrue
se desejar classificar os registros de forma decrescente. O valor padrão éfalse
.
{
"TotalRecordCount": 0,
"Value": [
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:21:22.771Z",
"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:21:22.771Z"
}
]
}
{
"TotalRecordCount": 0,
"Value": [
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:21:22.771Z",
"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:21:22.771Z"
}
]
}
query
tem os seguintes componentes:
- totalRecordCount - O número total de registros correspondentes aos filtros de consulta especificados.
- value - Uma matriz de registros de entidade que correspondem aos filtros de consulta especificados, limitados pela propriedade limit .
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.