Pesquisar K
Appearance
Enviar dados de sincronização
POST
/v2/sync/{syncRunId}/uploadEntities
Enviar entidades para sincronização com a Layers.
Autorizações
Bearer
Generate a token
TipoHTTP (bearer)
Parâmetros
Parâmetros de Cabeçalho
community-id*
Identificador da comunidade
Tipostring
ObrigatórioExemplo
"test"Parâmetros de Caminho
syncRunId*
Identificador da rodada de sincronização
Tipostring
ObrigatórioExemplo
"test"Corpo da Requisição
application/json
JSON
{
"groups": {
"data": [
{
"alias": "string",
"name": "string",
"enrollments": {
"users": [
"string"
],
"members": [
"string"
]
},
"members": [
[
"string"
]
],
"adminsSet": [
[
"string"
]
],
"admins": [
{
"email": "string",
"alias": "string",
"components": [
"string"
]
}
],
"components": [
[
"string"
]
],
"tags": [
"ensino-medio"
],
"fields": {
"education:basic": {
"tipo": "string",
"nivel": "string",
"periodo": [
"string"
]
}
},
"season": "string",
"active": true
}
],
"removeUnlistedAdmins": true,
"removeUnlistedComponents": true,
"removeUnlistedEnrollments": true,
"removeUnlistedTags": true
},
"members": {
"data": [
{
"active": true,
"users": [
"string"
],
"alias": "string",
"birth": "string",
"name": "string"
}
],
"removeUnlistedUsers": true
},
"users": {
"data": [
{
"active": true,
"alias": "string",
"name": "string",
"email": "string",
"birth": "string",
"rolesSet": {
"student": true,
"guardian": true,
"professor": true,
"coordenator": true,
"admin": true
}
}
]
},
"components": {
"data": [
{
"active": true,
"alias": "string",
"name": "string",
"fields": {
"@education:basic": {
"inep": "1"
}
}
}
]
}
}
Respostas
Upload recebido
POST
/v2/sync/{syncRunId}/uploadEntities
Exemplos
cURL
JavaScript
PHP
Python