Iniciar a sincronização depois de carregar ficheiros para um educationSynchronizationProfile (preterido)
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Cuidado
A API do Perfil de Sincronização de Educação foi preterida e deixará de devolver dados a 31 de dezembro de 2024. Para obter informações sobre como migrar para a nova API de Dados do Setor, veja Transição do School Data Sync (Clássico).
Verifique os ficheiros carregados para um perfil de sincronização de dados escolares específico no inquilino. Se a verificação for efetuada com êxito, a sincronização é iniciada no perfil. Caso contrário, a resposta contém erros e avisos. Se a resposta contiver erros, a sincronização não será iniciada. Se a resposta contiver apenas avisos, a sincronização é iniciada.
Nota: Utilize este método apenas quando o fornecedor de dados for do tipo educationcsvdataprovider. Além disso, a propriedade de estado do perfil tem de ser aprovisionada antes de poder ser iniciada. Consulte o objeto de perfil para verificar a respetiva propriedade de estado.
Esta API está disponível nas seguintes implementações de cloud nacionais.
Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
---|---|---|
Delegado (conta corporativa ou de estudante) | EduAdministration.ReadWrite | Indisponível. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | EduAdministration.ReadWrite.All | Indisponível. |
Solicitação HTTP
POST /education/synchronizationProfiles/{id}/start
Cabeçalhos de solicitação
Nome | Tipo | Descrição |
---|---|---|
Autorização | string | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se tiver êxito, este método retornará um código de resposta 200 OK
. Se não for bem-sucedido, devolve um 400 Bad Request
. A resposta contém uma coleção de objetos educationFileSynchronizationVerificationMessage como parte do corpo da resposta se forem encontrados erros ou avisos.
Exemplo
Solicitação
O exemplo a seguir mostra uma solicitação.
POST https://graph.microsoft.com/beta/education/synchronizationProfiles/{id}/start
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#education/Collection(microsoft.graph.verificationMessage)",
"value": [
{
"type": "Error",
"fileName": "section.csv",
"description": "5 row(s) have missing data for the field - SIS ID"
},
{
"type": "Error",
"fileName": "section.csv",
"description": "5 row(s) have an invalid format for the field - SIS ID"
},
{
"type": "Warning",
"fileName": "student.csv",
"description": "3 duplicates found in column SIS ID which requires values to be Unique."
},
{
"type": "Warning",
"fileName": "student.csv",
"description": "3 duplicates found in column Username which requires values to be Unique."
},
{
"type": "Error",
"fileName": "studentenrollment.csv",
"description": "125 row(s) have referenced data not found in source. Field - Section SIS ID"
},
{
"type": "Error",
"fileName": "studentenrollment.csv",
"description": "35 row(s) have referenced data not found in source. Field - SIS ID"
},
{
"type": "Warning",
"fileName": "teacher.csv",
"description": "3 duplicates found in column SIS ID which requires values to be Unique."
},
{
"type": "Warning",
"fileName": "teacher.csv",
"description": "3 duplicates found in column Username which requires values to be Unique."
},
{
"type": "Error",
"fileName": "teacherroster.csv",
"description": "10 row(s) have referenced data not found in source. Field - Section SIS ID"
},
{
"type": "Error",
"fileName": "teacherroster.csv",
"description": "91 row(s) have referenced data not found in source. Field - SIS ID"
}
]
}