[post-image]: https://img.shields.io/badge/-POST-yellow
[get-image]: https://img.shields.io/badge/-GET-green
# Rotas para o connector solutis-remedy
## __INCIDENTES E REQUISIÇÕES__
***
### */ticket/store* ![POST][post-image]
> Cria um novo Incidente/Requisição na ferramenta da remedy, o token de autenticação deve ser enviado via headers para que a requisição seja exucutada
```json
EXEMPLO HEADERS:
{
"Authorization": "Bearer [*token da aplicação*]"
}
```
```json
EXEMPLO BODY:
{
"customer_company":"ELETROBRAS",
"login_id": "EVSOFER",
"ticket_summary": "SUMÁRIO DO INCIDENTE",
"ticket_notes": "CAMPO NOTAS DO INCIDENTE",
"vendor_ticket": "",
"category_1": "",
"category_2": "",
"category_3": "",
"impact": "4-Minor/Localized",
"urgency": "4-Low",
"service_type": "User Service Restoration",
"reported_source": "Systems Management",
"status": "New",
"template_id": "12345678"
"status_reason": "",
"assignee": "",
"assigned_support_company": "",
"assigned_group": "Atendimento Geral",
"assigned_support_organization": "",
"resolution": "",
"file_name": "image.png",
"file_base_64": "data:image/png;base64,kbasbjshbhjjdjedehebej63i,3dkdk==",
"file_size":12345,
}
```
```json
EXEMPLO RESPOSTA:
{
"ticket_id": "REQ000000000",
"incident_id": "INC000000000"
}
```
### Detalhamento dos campos
> - **customer_company** : Obrigatório | *empresa do solicitante, uma das opções abaixo*
>>* CEPEL
>>* CHESF
>>* ELETROBRAS
>>* ELETRONORTE
>>* ELETRONUCLEAR
>>* ELETROSUL
>>* FURNAS
> - **login_id** : Obrigatório | *id do login do usuário na ferramenta*
> - **ticket_summary** : Obrigatório | *título do chamado, solicitação resumida*
> - **ticket_notes** : Obrigatório | *descrição do chamado, toda a solicitação do usuário*
> - **vendor_ticket** : Opcional | *ticket do fornecedor*
> - **category_1** : Opcional | *1° categorização do incidente*
> - **category_2** : Opcional | *2° categorização do incidente*
> - **category_3** : Opcional | *3° categorização do incidente*
> - **impact** : Obrigatório | *Uma das opções abaixo*
>> * 1-Extensive/Widespread
>> * 2-Significant/Large
>> * 3-Moderate/Limited
>> * 4-Minor/Localized
> - **urgency** : Obrigatório | *Uma das opções abaixo*
>> * 1-Critical
>> * 2-High
>> * 3-Medium
>> * 4-Low
> - **service_type** : Obrigatório | *Tipo do incidente, uma das opções abaixo*
>> * User Service Restoration
>> * User Service Request
>> * Infrastructure Restoration
>> * Infrastructure Event
> - **reported_source** : Obrigatório | *Origem do chamado, uma das opções abaixo*
>> * Chat
>> * Direct Input
>> * Email
>> * Self Service
>> * Systems Management
>> * Phone
>> * Walk In
> - **template_id** : Opcional | *id para um template de informações de chamado*
> - **status** : Obrigatório | *Status do tickect, uma das opções abaixo*
>> * New
>> * Assigned
>> * In Progress
>> * Pending
>> * Resolved
>> * Closed
>> * Cancelled
> - **status_reason** : Opcional | _(Obrigatório quando o status for igual a `Resolved`)_ | *Motivo do status, uma das opções abaixo*
>> * Infrastructure Change Created
>> * Local Site Action Required
>> * Purchase Order Approval
>> * Registration Approval
>> * Supplier Delivery
>> * Support Contact Hold
>> * Third Party Vendor Action Reqd
>> * Client Action Required
>> * Infrastructure Change
>> * Request
>> * Future Enhancement
>> * Pending Original Incident
>> * Monitoring Incident
>> * Customer Follow-Up Required
>> * Temporary Corrective Action
>> * No Further Action Required
>> * Resolved by Original Incident
>> * Automated Resolution Reported
>> * No longer a Causal CI
>> * Pending Causal Incident Resolution
>> * Resolved by Causal Incident
> - **assignee** : Opcional | _(Obrigatório quando o status for igual a `Resolved`)_ | *Deve ser preenchido pelo nome do administrador quando o status for 'atribuído'*
> - **resolution** : Opcional | *Solução do chamado*
> - **assigned_support_company** : Opcional | *Deve ser preenchido pelo nome da empresa quando o status for 'atribuído'*
> - **assigned_group** : Opcional | *Deve ser preenchido pelo grupo do administrador quando o status for 'atribuído'*
> - **assigned_support_organization** : Opcional | *Deve ser preenchido pela organização do administrador quando o status for 'atribuído'*
> - **file_name** : Opcional | *Nome do arquivo com extensão*
> - **file_base_64** : Opcional | *Código base 64 do arquivo*
> - **file_size** : Opcional | *Tamanho do arquivo em bytes*
### */ticket/show* ![POST][post-image]
> Busca uma requisição na ferramenta remedy, o token de autenticação deve ser enviado via headers para que a requisição seja exucutada
```json
EXEMPLO HEADERS:
{
"Authorization": "Bearer [*token da aplicação*]"
}
```
```json
EXEMPLO ENVIO:
{
"ticket_id": "REQ00000000000"
}
```
```json
EXEMPLO RETORNO:
{
"InstanceID": "AGGAA5V0HIO5MASFVD2GSEUO3R99UO",
"Request_Number": "REQ000000473739",
"Customer_Company": "ELETRONORTE",
"Requested_For_Login_ID": "N.GOV.BR",
"Customer_First_Name": "TESTE",
"Customer_Middle_Name": "",
"Customer_Last_Name": "3",
"Customer_Internet_E-mail": "teste@",
"Customer_Phone_Number": "1",
"Customer_Organization": "DF",
"Customer_Department": "",
"Request_Manager_Login": "aaa",
"Site": "ELN - SEDE",
"Summary": "MODIFY TESTE",
"Details": "TESTE PARA MODIFY\nBLABLABLA?BLa",
"Impact": "4-Minor/Localized",
"Urgency": "4-Low",
"Status": "Planning",
"Status_Reason": null,
"Submit_Date": "2023-12-18T09:14:28-03:00"
}
```
***
### */ticket/modify* ![POST][post-image]
> Modifica um incidente na ferramenta remedy, é possível enviar no corpo da requisição apenas os campos que deseja modificar, verifique abaixo quais campos podem ser enviados.
> O token de autenticação deve ser enviado via headers para que a requisição seja exucutada
```json
EXEMPLO HEADERS:
{
"Authorization": "Bearer [*token da aplicação*]"
}
```
```json
EXEMPLO ENVIO:
{
"Incident_Number": "INC00000000000",
"Summary": "Novo sumário"
}
```
### Campos que podem ser enviados
> - **Incident_Number** : Obrigatório | *número do incidente que deseja modificar*
> - **Summary** : Opcional | *título do chamado, solicitação resumida, equivalente ao campo da interface: **Sumário\****
> - **Notes** : Opcional | *descrição do chamado, toda a solicitação do usuário, equivalente ao campo da interface: **Notas***
> - **Categorization_Tier_1** : Opcional | *1° categorização do incidente, equivalente ao campo da interface: **Categorização Operacional Nível 1+***
> - **Categorization_Tier_2** : Opcional | *2° categorização do incidente, equivalente ao campo da interface: **Categorização Operacional Nível 2***
> - **Categorization_Tier_3** : Opcional | *3° categorização do incidente, equivalente ao campo da interface: **Categorização Operacional Nível 3***
> - **Impact** : Opcional | *impacto do incidente, equivalente ao campo da interface: **Impacto\****
> - **Manufacturer** : Opcional | *equivalente ao campo da interface: **Fabricante***
> - **Product_Categorization_Tier_1** : Opcional | *1° categorização do produto, equivalente ao campo da interface: **Categorização do Produto Nível 1***
> - **Product_Categorization_Tier_2** : Opcional | *2° categorização do produto, equivalente ao campo da interface: ** **Categorização do Produto Nível 2***
> - **Product_Categorization_Tier_3** : Opcional | *3° categorização do produto, equivalente ao campo da interface: **Categorização do Produto Nível 3***
> - **Product_Model_Version** : Opcional | *equivalente ao campo da interface: **Categorização do Produto Modelo/Versão***
> - **Product_Name** : Opcional | *equivalente ao campo da interface: **Categorização do Produto Nome do Produto+***
> - **Resolution** : Opcional | *equivalente ao campo da interface: **Resolução***
> - **Service_Type** : Opcional | *equivalente ao campo da interface: **Tipo de Incidente\****
> - **Assignee** : Opcional | *equivalente ao campo da interface: **Designado+***
> - **Status** : Opcional | *equivalente ao campo da interface: **Status\****
> - **Urgency** : Opcional | *equivalente ao campo da interface: **Urgência\****
> - **Reported_Source** : Opcional | *equivalente ao campo da interface: **Origem Informada***
> - **Status_Reason** : Opcional | *equivalente ao campo da interface: **Motivo do status***
<!--
> - **Resolution** : Opcional | *equivalente ao campo da interface: **Resolução***
> - **Resolution** : Opcional | *equivalente ao campo da interface: **Resolução***
> - **Resolution** : Opcional | *equivalente ao campo da interface: **Resolução*** -->
### /ticket/show_summary ![POST][post-image]
> Busca requisições no remedy que contém o sumário informado, o token de autenticação deve ser enviado via headers para que a requisição seja exucutada
```json
EXEMPLO HEADERS:
{
"Authorization": "Bearer [*token da aplicação*]"
}
```
```json
EXEMPLO ENVIO:
{
"ticket_summary": "SUMÁRIO ABC"
}
```
```json
EXEMPLO RETORNO:
[
{
"InstanceID": "AGGAA5V0HIO5MASG58A9SF5DCEWQ1P",
"Request_Number": "REQ0000000000",
"Customer_Company": "ELETROBRAS",
"Requested_For_Login_ID": "000000",
"Customer_First_Name": "teste",
"Customer_Middle_Name": "teste",
"Customer_Last_Name": "teste",
"Customer_Internet_E-mail": "teste@solutis.com.br",
"Customer_Phone_Number": " ",
"Customer_Organization": "DA",
"Customer_Department": "DA/DAC/DACQ",
"Request_Manager_Login": "teste",
"Site": "HSTOLTZ",
"Summary": "SUMÁRIO ABC",
"Details": "CAMPO NOTAS DO INCIDENTE",
"Impact": "4-Minor/Localized",
"Urgency": "4-Low",
"Status": "Planning",
"Status_Reason": null,
"Submit_Date": "2023-12-29T09:43:29-03:00"
},
{
"InstanceID": "AGGAA5V0HIO5MASG58B0SF5DCVWQ3W",
"Request_Number": "REQ0000000000",
"Customer_Company": "ELETROBRAS",
"Requested_For_Login_ID": "0000000",
"Customer_First_Name": "teste",
"Customer_Middle_Name": "teste",
"Customer_Last_Name": "teste",
"Customer_Internet_E-mail": "teste@solutis.com.br",
"Customer_Phone_Number": " ",
"Customer_Organization": "DA",
"Customer_Department": "DA/DAC/DACQ",
"Request_Manager_Login": "teste",
"Site": "teste",
"Summary": "SUMÁRIO ABC",
"Details": "CAMPO NOTAS DO INCIDENTE",
"Impact": "4-Minor/Localized",
"Urgency": "4-Low",
"Status": "Planning",
"Status_Reason": null,
"Submit_Date": "2023-12-29T09:43:57-03:00"
},
{
"InstanceID": "AGGAA5V0HIO5MASG58B9SF5DDEWQ6I",
"Request_Number": "REQ0000000000000",
"Customer_Company": "ELETROBRAS",
"Requested_For_Login_ID": "-0000000",
"Customer_First_Name": "teste",
"Customer_Middle_Name": "teste",
"Customer_Last_Name": "teste",
"Customer_Internet_E-mail": "teste@solutis.com.br",
"Customer_Phone_Number": " ",
"Customer_Organization": "DA",
"Customer_Department": "DA/DAC/DACQ",
"Request_Manager_Login": "teste",
"Site": "teste",
"Summary": "SUMÁRIO ABC",
"Details": "CAMPO NOTAS DO INCIDENTE",
"Impact": "4-Minor/Localized",
"Urgency": "4-Low",
"Status": "Planning",
"Status_Reason": null,
"Submit_Date": "2023-12-29T09:44:06-03:00"
}
]
```
***
### /ticket/show_inc ![POST][post-image]
> Busca um incidente na ferramenta remedy, o token de autenticação deve ser enviado via headers para que a requisição seja exucutada
```json
EXEMPLO HEADERS:
{
"Authorization": "Bearer [*token da aplicação*]"
}
```
```json
EXEMPLO ENVIO:
{
"ticket_id": "INC00000000000"
}
```
```json
EXEMPLO RETORNO:
{
"Assigned_Group": "Atendimento Geral",
"Assigned_Group_Shift_Name": "",
"Assigned_Support_Company": "CSC GLOBAL",
"Assigned_Support_Organization": "Central de Atendimento",
"Assignee": "",
"Categorization_Tier_1": "",
"Categorization_Tier_2": "",
"Categorization_Tier_3": "",
"City": "Rio De Janeiro",
"Closure_Manufacturer": "",
"Closure_Product_Category_Tier1": "Sistema Corporativo",
"Closure_Product_Category_Tier2": "Administração",
"Closure_Product_Category_Tier3": "Tecnologia da Informação",
"Closure_Product_Model_Version": "",
"Closure_Product_Name": "",
"Company": "ELETROBRAS",
"Contact_Company": "ELETROBRAS",
"Contact_Sensitivity": "Standard",
"Country": "Brazil",
"Department": "teste",
"Summary": "SUMÁRIO DO INCIDENTE",
"Notes": "teste",
"First_Name": "nome",
"Impact": "2-Significant/Large",
"Last_Name": "sobrenome",
"Manufacturer": "",
"Middle_Initial": "teste",
"Organization": "teste",
"Phone_Number": "0000000000",
"Priority": "High",
"Priority_Weight": "20",
"Product_Categorization_Tier_1": "",
"Product_Categorization_Tier_2": "",
"Product_Categorization_Tier_3": "",
"Product_Model_Version": "",
"Product_Name": "",
"Region": "",
"Resolution": "",
"Resolution_Category": "",
"Resolution_Category_Tier_2": "",
"Resolution_Category_Tier_3": "",
"Service_Type": "User Service Restoration",
"Site": "HSTOLTZ",
"Site_Group": "",
"Status": "Assigned",
"Urgency": "2-High",
"VIP": "No",
"ServiceCI": "",
"HPD_CI": "teste",
"HPD_CI_ReconID": "teste",
"HPD_CI_FormName": "teste",
"z1D_CI_FormName": "AST:Application",
"Status_Reason": null,
"SRID": "REQ000000000",
"Reported_Source": "Systems Management"
}
```
***
<!--
## __ORDEM DE TRABALHO__
***
### ![POST][post-image] */ticket/store_wo*
> Cria uma nova ordem de trabalho na ferramenta da remedy, o token de autenticação deve ser enviado via headers para que a requisição seja exucutada
```json
EXEMPLO HEADERS:
{
"Authorization": "Bearer token"
}
```
```json
EXEMPLO BODY:
{
"customer_company":"ELETROBRAS",
"customer_first_name":"Eve",
"customer_last_name":"Silva",
"summary":"SUMÁRIO DA WO",
"detailed_description":"DESCRIÇÃO WO",
"category_1":"",
"category_2":"",
"category_3":"",
"work_info_summary":"SUMMARY 2 WO",
"work_info_details":"DETAILS 2 WO",
"work_info_type":"WorkInfo created Before SR Submit"
}
```
```json
EXEMPLO RESPOSTA:
{
"ticket_id": "WO00000000000"
}
```
### Detalhamento dos campos
> - **customer_company** : Obrigatório | *empresa do solicitante, uma das opções abaixo*
>>* CEPEL
>>* CHESF
>>* ELETROBRAS
>>* ELETRONORTE
>>* ELETRONUCLEAR
>>* ELETROSUL
>>* FURNAS
> - **customer_first_name** : Obrigatório | *primeiro nome do usuário na ferramenta*
> - **customer_last_name** : Obrigatório | *último nome do usuário na ferramenta*
> - **summary** : Obrigatório | *sumário da solicitação*
> - **detailed_description** : Opcional | *detalhes da solicitação*
> - **category_1** : Opcional | *1° categorização da solicitação*
> - **category_2** : Opcional | *2° categorização da solicitação*
> - **category_3** : Opcional | *3° categorização da solicitação*
> - **work_info_summary** : Opcional | *sumário da ordem de trabalho*
> - **work_info_details** : Opcional | *detalhes da ordem de trabalho*
> - **work_info_type** : Opcional | *tipo da ordem de trabalho, uma das opções abaixo*
>>* Request Primary Attachment
>>* WorkInfo created Before SR Submit
>>* WorkInfo created After SR Submit
### ![POST][post-image] */ticket/show_wo*
> Busca uma ordem de trabalho na ferramenta da remedy, o token de autenticação deve ser enviado via headers para que a requisição seja exucutada
```json
EXEMPLO HEADERS:
{
"Authorization": "Bearer token"
}
```
```json
EXEMPLO ENVIO:
{
"ticket_id": "WO00000000000"
}
```
```json
EXEMPLO RETORNO:
{
"ticket_id": "WO00000000000",
"status": "Assigned",
"description": "DESCRIÇÃO DA WO",
"priority": "Low",
"company": "ELETROBRAS",
"phone_number": "+55999999999",
"customer_email": "xxx.xxx@eletrobras.com",
"summary": "SUMÁRIO DA WO",
"req_id": "REQ000000470811",
}
```
-->