Índice

exclude	Sumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

Para mais informações sobre consumo de Licença, Veja Aqui.

1 - Métodos

...

Serão apresentados 4 métodos, os quais foram implementados na API de Usuários, são eles:

...

Informações

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/users

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "id": "00001",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00001",
            "name": {
                "formatted": "ITAMAR MENDES DA SILVEIRA"
            },
            "userName": "00001",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00001-02-98",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00001-02-98",
            "name": {
                "formatted": "ALONSO LIGORIO PINTO"
            },
            "userName": "00001-02-98",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "0000125",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "0000125",
            "name": {
                "formatted": "RUDIVAL JOSE DOS SANTOS"
            },
            "userName": "0000125",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00002",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00002",
            "name": {
                "formatted": "JOAO DA SILVA JORDAM"
            },
            "userName": "00002",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00003",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00003",
            "name": {
                "formatted": "MARIA CONCEICAO DE ASSIS"
            },
            "userName": "00003",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00004",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00004",
            "name": {
                "formatted": "ADALBERTO DE JESUS LIMA"
            },
            "userName": "00004",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00005",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00005",
            "name": {
                "formatted": "ALESSANDRA LOPES DE ABREU"
            },
            "userName": "00005",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00006",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00006",
            "name": {
                "formatted": "FERNANDO HENRIQUE VALLE KURTEN"
            },
            "userName": "00006",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00007",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00007",
            "name": {
                "formatted": "JOAQUIM FARIAS DAMASCENO"
            },
            "userName": "00007",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00008",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00008",
            "name": {
                "formatted": "ZELIA APARECIDA DA SILVA"
            },
            "userName": "00008",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00009",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00009",
            "name": {
                "formatted": "BEATRIZ MENGA"
            },
            "userName": "00009",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00010",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00010",
            "name": {
                "formatted": "ANTONIO GATES BILL"
            },
            "userName": "00010",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00011",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00011",
            "name": {
                "formatted": "MARCELO MATTAR DINIZ"
            },
            "userName": "00011",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00012",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00012",
            "name": {
                "formatted": "ANA LUIZA  DE SOUZA PRATES"
            },
            "userName": "00012",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00013",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00013",
            "name": {
                "formatted": "ALEXANDRE COTTA LEAO"
            },
            "userName": "00013",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00014",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00014",
            "name": {
                "formatted": "PEDRO DE ALCANTARA"
            },
            "userName": "00014",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00015",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00015",
            "name": {
                "formatted": "LEOPOLDO DOS SANTOS DE OLIVEIRA NETO"
            },
            "userName": "00015",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00038-02-105",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00038-02-105",
            "name": {
                "formatted": "WILMAN MAIA CABRAL"
            },
            "userName": "00038-02-105",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00039",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00039",
            "name": {
                "formatted": "ANTONIO CARLOS DE BRAGANÇA"
            },
            "userName": "00039",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        },
        {
            "id": "00047",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00047",
            "name": {
                "formatted": "RODRIGO FIALHO BARRICHELLO"
            },
            "userName": "00047",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        }
    ]
}

...

Informações

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{id}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 00001

Url Utilizada: http://localhost:8051/api/framework/v1/users/00001

Informações

icon	false
title	Exemplo de Resultado

expand

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "_expandables": [
        "roles"
    ],
    "id": "00001",
    "meta": {
        "resourceType": "User",
        "created": "2014-07-07T15:32:15",
        "lastModified": "2018-10-04T17:02:10"
    },
    "externalId": "82cca8a8-9198-4508-95c3-a0a40dc34fa2",
    "name": {
        "formatted": "ITAMAR",
        "givenName": "ITAMAR"
    },
    "userName": "00001",
    "emails": [
        {
            "value": "[email protected]",
            "primary": true
        }
    ],
    "active": true
}

Informações

icon	false
title	1.1.6 GetOne expandable

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{id}?expand={campo}

title

Informações

icon	false
title	Exemplo de Configuração

icon

false

Domínio: localhost

Porta: 8051

Id: 00001

Url Utilizada: http://localhost:8051/api/framework/v1/users/00001?expand=roles

Informações

Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "_expandables": [
        "roles"
    ],
    "id": "00001",
    "meta": {
        "resourceType": "User",
        "created": "2014-07-07T15:32:15",
        "lastModified": "2018-10-04T17:02:10"
    },
    "externalId": "82cca8a8-9198-4508-95c3-a0a40dc34fa2",
    "name": {
        "formatted": "ITAMAR",
        "givenName": "ITAMAR"
    },
    "userName": "00001",
    "emails": [
        {
            "value": "[email protected]",
            "primary": true
        }
    ],
    "active": true,
    "roles": [
        {
            "company": "1",
            "value": "DBA Custo"
        },
        {
            "company": "1",
            "value": "_eq_1EquipeNet_A"
        },
        {
            "company": "1",
            "value": "_me_1FeriasNet_A"
        },
        {
            "company": "1",
            "value": "DBA_A"
        },
        {
            "company": "12",
            "value": "DBA_G"
        }
    ]
}

1.2 - POST

...

1.2.1 - Post (Inserir um usuário)

...

Informações

icon	false
title	1.5.1 Patch

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{id}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: Teste_01

Url Utilizada: http://localhost:8051/api/framework/v1/users/Teste_01

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"name":
	{
            "givenName": {{givenName_formatted}}
    },
    "emails": [
        {
            "value": {{email_formatted}},
            "primary": true
        }
    ],
    "active": {{active}}
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "id": "Teste_01",
    "meta": {
        "resourceType": "User",
        "created": "2018-12-05T15:03:07.28",
        "lastModified": "2018-12-05T15:03:08.5546578"
    },
    "externalId": "IDTeste_01External",
    "name": {
        "formatted": "NOME SOCIAL DO TESTE_01",
        "givenName": "Igor",
        "familyName": "Automatizado"
    },
    "userName": "Teste_01",
    "emails": [
        {
            "value": "[email protected]",
            "primary": true
        }
    ],
    "active": true
}

Referências (Links)

...

Roles (Manipulação de Perfis) A partir da versão 12.1.2306

...

Informações

title	Associação de Perfis (Roles)

Para adicionar e remover perfis á um usuário é necessário realizar as operações de Post/Delete nas rotas de perfis conforme abaixo

Expandir

title	Víncular perfil ao usuário (Post)

Informações

icon	false

Método HTTP: Post

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{user}/roles

Informações

icon	false
title	Exemplo de Configuração

Url Utilizada: http://localhost:8051/api/framework/v1/users/apiteste/roles

Variável	Descrição	Valor
domínio	endereço do serviço de webservice	localhost
porta	porta do serviço	8051
user	código do usuário	apiteste

Expandir

title	Exemplo Sucesso

Informações

icon	false
title	Request Body

Bloco de código

language	js
title	Json
linenumbers	true

{
	"roles": [
		{
			"company": "0",
			"value": "DBA_G"
		}
	]
}

Informações

icon	false
title	Response

HttpStatus: 200

Bloco de código

language	js
title	Json
linenumbers	true

{
    "id": "apiteste",
    "roles": [
        {
            "company": "1",
            "value": "DBA_G"
        },
        {
            "company": "6",
            "value": "DBA_G"
        },
        {
            "company": "7",
            "value": "DBA_G"
        }
    ]
}

Aviso

title	Atenção

Ao enviar o codigo da coligada (Company) como 0 o sistema irá adicionar o perfil para todas as coligadas que o usuário possuir permissão.

Como no exemplo da resposta, o perfil DBA_G foi associado para as coligadas 1,6 e 7.

Expandir

title	Exemplo Erro

Expandir

title	Usuário já possui algum perfil associado

Informações

icon	false
title	Request Body

Bloco de código

language	js
title	Json
linenumbers	true

{
	"roles": [
		{
			"company": "0",
			"value": "DBA_G"
		}
	]
}

HttpStatus: 400

Informações

icon	false
title	Response

{
    "Code": "FE019",
    "Message": "Usuário APITESTE já está associado ao perfil 'CodColigada:'1'|Sistema:'G'|CodPerfil:'DBA'|IdPerfil:DBA_G'!",
    "DetailMessage": "",
    "HelpUrl": "",
    "Details": null
}

Expandir

title	Usuário sem permissão

Informações

icon	false
title	Request Body

Bloco de código

language	js
title	Json
linenumbers	true

{
	"roles": [
		{
			"company": "0",
			"value": "DBA_S"
		}
	]
}

HttpStatus: 401

Informações

icon	false
title	Response

{
    "Code": "FE005",
    "Message": "O Usuário informado não tem permissão para associar perfis na coligada 1 sistema S!",
    "DetailMessage": "",
    "HelpUrl": "",
    "Details": null
}

Expandir

title	Remover perfil do usuário (Delete)

Informações

icon	false

Método HTTP: Delete

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{user}/roles/company/{company}/role/{role}

Informações

icon	false
title	Exemplo de Configuração

Url Utilizada: http://localhost:8051/api/framework/v1/users/apiteste/roles/company/0/role/DBA_S

Variável	Descrição	Valor
domínio	endereço do serviço de webservice	localhost
porta	porta do serviço	8051
user	código do usuário	apiteste
company	código da coligada que será utilizada	0
role	Identificador(IDPERFIL) do perfil que será atribuído	DBA_S

Informações

icon	false
title	Response (Sucesso ou Erro)

HttpStatus: 204

Response Body: Vazio

Aviso

title	Atenção

Por padrão, nas mensagens de DELETE, a resposta deve ser enviada com HTTP Code 204 (No content) e sem corpo no retorno, mesmo se não obtiver sucesso.

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 52

Nova versão Atual

Chave

Objetivo

1 - Métodos

1.2 - POST

1.2.1 - Post (Inserir um usuário)

Referências (Links)

Roles (Manipulação de Perfis) A partir da versão 12.1.2306

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 52

Nova versão Atual

Chave

Objetivo

1 - Métodos

1.2 - POST

1.2.1 - Post (Inserir um usuário)

Referências (Links)

Roles (Manipulação de Perfis) A partir da versão 12.1.2306