Histórico da Página

Aviso

title	Documentações Rest

As documentações à seguir, foram criadas pois, porque existem particularidades nas chamadas RESTs.
Para os outros serviços RESTS, deve-se seguir as recomendações da Framework TOTVS.

Informações

title	Dicas

Para auxiliar na compreensão de como preencher os parâmetros (obtidos pela chamada do GetSchema do processo) para execução do processo, execute o processo com sucesso via MDI e utilize as informações da execução disponíveis no monitor de Jobs (Ambiente | Monitor de Jobs). Na lista de Jobs, edite o respectivo Job, e visualize os parâmetros que foram informados para a execução do processo na aba Processo:

Expandir

title	Exemplo de dados da aba Processo

Image Added

Ou visualize essas informações em formato XML acessando o menu Anexos | XML de parâmetros de Jobs - Última utilização - (WebServices). Dependendo do tipo do parâmetro do processo, só será possível visualizar essas informações em detalhes utilizando a opção de parâmetros em formado XML.

Ex: As informações de preenchimento de PrimaryKeyList e PrimaryKeyNames estão detalhadas somente no formato XML:

Expandir

title	Exemplo de dados do anexo XML de parâmetros de Jobs - Última utilização - (WebServices)

Image Added

O body da seguinte requisição foi preenchido seguindo as dicas:

Expandir

title	Exemplo da requisição para execução do processo EduGeracaoUsuariosData

Url: http://localhost:8051/rest/restprocess/executeProcess/EduGeracaoUsuariosData

Bloco de código

title	Body

{
    "TipoGeracao": "Aluno",
    "TipoGeracaoUsuarioAluno": "Aluno",
    "CodColigada": 1,
    "CodSistema": "S",
    "CodTipoCurso": 1,
    "CodFilial": 1,
    "CodPerfil": "Aluno [ES]",
    "CodPerfilPortal": "CriadorConteudo",
    "CodPerfilAgilis": null,
    "CodPerfilBiblios": null,
    "CodPerfilConteudo": 0,
    "CodAcesso": "TOTVSEdu",
    "ListLocalidades": [
        12,
        14,
        5,
        7
    ],
    "DataInicioSenha": null,
    "DataExpiracao": null,
    "DataExpiracaoSenha": null,
    "Senha": "123456",
    "SenhaResponsavel": null,
    "SenhaResponsavelFinanceiro": null,
    "ForcaTrocaSenha": false,
    "DiasTrocaSenha": 0,
    "ObrigaTrocaSenha": false,
    "RegerarSenha": false,
    "CampoComplementarSenha": null,
    "TipoSenha": 0,
    "TipoSenhaResponsavel": 0,
    "TipoSenhaResponsavelFinanceiro": 0,
    "CodigoProfessor": 0,
    "CodigoAluno": "RA",
    "CodigoResponsavelAluno": 0,
    "CodigoResponsavelFinanceiroAluno": 0,
    "CodigoCoordenador": 0,
    "CodigoFuncionarioEmpresa": 0,
    "CodigoPesquisador": 0,
    "CodPerfilResp": null,
    "CodPerfilRespFinanceiro": null,
    "CodPerfilPortalResp": null,
    "CodPerfilPortalRespFinanceiro": null,
    "OrdemPrioGeracaoUsuario": null,
    "OrdemPrioGeracaoUsuarioResponsavel": null,
    "OrdemPrioGeracaoUsuarioResponsavelFinanceiro": null,
    "TipoAcessoSistema": "Portal",
    "TipoAcessoSistemaResp": 2,
    "TipoAcessoSistemaRespFin": 0,
    "LstEmpresaFuncionario": [
        {
            "IdEmpresa": 0,
            "IdFuncionario": 0,
            "Nome": null,
            "Telefone": null,
            "Chapa": null,
            "Email": null,
            "Cargo": null,
            "Cpf": null,
            "Funcao": 0,
            "Ativo": false,
            "NrPassaporte": null,
            "PaisOrigemPassaporte": null,
            "DtEmissaoPassaporte": null,
            "DtValidadePassaporte": null,
            "RFC": null,
            "NumeroCartaoCidadao": null,
            "OrgaoExpedicaoCartaoCidadao": null,
            "DtEmissaoCartaoCidadadao": null,
            "DtValidadeCartaoCidadadao": null,
            "IdPais": null,
            "Empresa": {
                "IdEmpresa": 0,
                "NomeFantasia": null,
                "Nome": null,
                "Cnpj": null,
                "Rua": null,
                "Complemento": null,
                "Numero": null,
                "Bairro": null,
                "CodMunicipio": null,
                "NomeMunicipio": null,
                "Estado": null,
                "NomeEstado": null,
                "Cep": null,
                "IdPais": null,
                "CodPais": null,
                "NomePais": null,
                "Email": null,
                "Telefone": null,
                "Site": null,
                "NumProcesFluig": null,
                "ParceriaEstagio": false,
                "Categoria": null,
                "TipoDoc": null,
                "InternalId": null
            },
            "NumProcesFluig": null,
            "DtNascimento": null,
            "Rua": null,
            "Numero": null,
            "Complemento": null,
            "Bairro": null,
            "Estado": null,
            "Cep": null,
            "CodMunicipio": null,
            "CarteiraIdentidade": null,
            "UfCarteiraIdentidade": null,
            "OrgaoEmissorCarteiraIdentidade": null,
            "DtEmissaoCarteiraIdentidade": null,
            "CodPessoa": null,
            "EstadoNatal": null,
            "CodNaturalidade": null,
            "NomeNaturalidade": null,
            "InternalId": null
        }
    ],
    "GerarUsuarioAlunoSemMatricPL": false,
    "ListaFiliaisNiveisEnsino": [],
    "UsarNomeSocial": false,
    "UsarNomeSocialResp": false,
    "RemoverCaracteresEspeciais": false,
    "AtribuirPermissaoTodosNiveisEnsinoMatriculados": false,
    "CodUsuarioGerado": "",
    "PrimaryKeyList": [
        [            
            1,
            "0000169"
        ]
    ],
    "PrimaryKeyNames": [
        "CODCOLIGADA",
        "RA"
    ],
    "Context": {
        "$id": "1",
        "_params": {
            "$EXERCICIOFISCAL": 22,
            "$CODLOCPRT": -1,
            "$CODTIPOCURSO": 1,
            "$EDUTIPOUSR": "-1",
            "$CODUNIDADEBIB": -1,
            "$CODCOLIGADA": 1,
            "$RHTIPOUSR": "-1",
            "$CODIGOEXTERNO": "-1",
            "$CODSISTEMA": "S",
            "$CODUSUARIOSERVICO": "",
            "$IDPRJ": -1,
            "$CHAPAFUNCIONARIO": "-1",
            "$CODFILIAL": 1
        },
        "Environment": 4
    }
}

Páginas:

Exibir filhos

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Páginas: