Notas de Implementação:
Informações de Envio:
Cabeçalhos de Envio:
| Parâmetro | Valor | Descrição | Tipo de parâmetro | Tipo de dados |
|---|---|---|---|---|
| Authorization | Bearer | Hash gerado no login | Header | String |
Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar
Direitos:
GMOSERV_C
Itens de Menu:
GS01519,GS01546
Modelo:
Json com os dados do Item da Ordem de Serviço
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| CodigoOrdemServico | integer |
Opcional |
|
| Item | integer |
Opcional |
|
| CodigoTipoOrdemServico | string |
Obrigatório Tamanho Máximo: 2 |
|
| CodigoEquipe | string |
Opcional Tamanho Máximo: 3 |
|
| DataItem | date |
Opcional |
|
| Local | string |
Opcional |
|
| CodigoProduto | string |
Obrigatório Tamanho Máximo: 20 |
|
| DescricaoProduto | string |
Opcional |
|
| DescricaoComplementarProduto | string |
Opcional |
|
| CodigoReclamante | string |
Obrigatório Tamanho Máximo: 6 |
|
| CodigoRepresentante | string |
Opcional |
|
| CodigoResponsavel | string |
Opcional |
|
| Assunto | string |
Opcional |
|
| CodigoSolicitado | string |
Opcional Tamanho Máximo: 9 |
|
| DescricaoSolicitado |
Campo editável. |
string |
Obrigatório Tamanho Máximo: 2001 |
| Versao | string |
Opcional |
|
| CodigoSolucao | string |
Opcional Tamanho Máximo: 9 |
|
| DescricaoSolucao |
Campo editável. |
string |
Opcional Tamanho Máximo: 2001 |
| CodigoCliente | string |
Opcional /api/servicos/gs/Itemordemservico/CriarItemOS Tamanho Máximo: 6 |
|
| OrdemServicoTerceiro | string |
Opcional Tamanho Máximo: 2001 |
|
| ContatoOS |
Opcional |
||
| Divisao | string |
Opcional |
|
| PrioridadeOS | string |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"CodigoOrdemServico": 1,
"Item": 2,
"CodigoTipoOrdemServico": "string 3",
"CodigoEquipe": "string 4",
"DataItem": "2026-01-13",
"Local": "string 5",
"CodigoProduto": "string 6",
"DescricaoProduto": "string 7",
"DescricaoComplementarProduto": "string 8",
"CodigoReclamante": "string 9",
"CodigoRepresentante": "string 10",
"CodigoResponsavel": "string 11",
"Assunto": "string 12",
"CodigoSolicitado": "string 13",
"DescricaoSolicitado": "string 14",
"Versao": "string 15",
"CodigoSolucao": "string 16",
"DescricaoSolucao": "string 17",
"CodigoCliente": "string 18",
"OrdemServicoTerceiro": "string 19",
"ContatoOS": {
"Sequencia": 1,
"CodigoPessoa": "string 2",
"Nome": "string 3",
"Telefone": "string 4",
"Email": "string 5",
"Ramal": "string 6",
"IdProjetoPapel": 7,
"Foto": "string 8"
},
"Divisao": "string 20",
"PrioridadeOS": "string 21"
}
Informações de Retorno:
Cabeçalhos Adicionais:
| Nome | Descrição | Valor |
|---|---|---|
| cigam-api-version | Versão do build/compilação dessa versão da API | 2.1.8565.21067 |
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| success | boolean |
Opcional |
|
| hash | string |
Opcional |
|
| messages | string |
Opcional |
|
| data | Object |
Opcional |
|
| tipoLogin | string |
Opcional |
Formato de Resposta:
Retorna o status code de sucesso ou erro
| Código de status HTTP | Descrição | Modelo de resposta |
|---|---|---|
| 200 | OK |
application/json, text/json
Exemplo:
{
"success": true,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 400 | Requisição inválida |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 401 | Não autorizado |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 500 | Requisição falhou |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 502 | Falha de comunicação |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|