Webservices para uso na plataforma CITSmart

este documento tem o propósito de fornecer orientações a respeito dos web services disponibilizados para integração com o gerenciamento de serviço do citsmart os web services foram criados no citsmart para inclusão, atualização, consulta e cancelamento de solicitações de serviço (incidentes e requisições) antes de começar antes de se utilizar qualquer operação rest do citsmart, é necessário que o usuário esteja autenticado a autenticação é feita através da operação rest login na url /services/login , que recebe um objeto ctlogin contendo os atributos username , password e mediatype a operação login retorna um valor alfanumérico no atributo sessionid este mesmo sessionid deve ser utilizado nas outras chamadas rest o objeto retornado contém o código e descrição do erro em caso de problemas na execução da operação login o usuário autenticado compõe a chave para sincronização dos dados, quando o atributo synchronize tiver o valor true o serviço de atualização de solicitações contam com o atributo synchronize quando este atributo for true , o cadastro de usuário e o catálogo serviços serão automaticamente atualizados no citsmart a partir das informações enviadas na solicitação do webservice regra todos os serviços rest criados no citsmart recebem um objeto de entrada e retornam um objeto em caso de erro, o objeto de retorno contém o código e a descrição do erro quando não houver erro, além dos atributos definidos para cada serviço, o objeto de retorno contém a data e hora de execução e o id da operação o citsmart garante que toda solicitação é registrada na sua base de dados e um id da operação é retornado para o solicitante, mesmo em caso de erro ações criar um ticket (request create) pré condições configurar os contratos, grupos, fluxos e permissões criando uma requisição/incidente url /services/request/create atributos de entrada synchronize indica se as informações de usuário e/ou serviço serão sincronizadas sourcerequest informações da solicitação origem da classe ctrequest, contendo numberorigin número da solicitação no sistema de origem (obrigatório este atributo é necessário para que o 4biz mantenha o de para entre sua base de dados e o número original do sistema origem type tipo da solicitação (obrigatório) valores possíveis i=incidente ou r=requisição description descrição do incidente ou requisição (obrigatório) userid identificação de usuário do solicitante (obrigatório) será incluído se não existir na base do 4biz e o atributo synchronize for igual a true contact dados do solicitante obrigatório quando o solicitante não existir no 4biz e o atributo synchronize for igual a true) name nome do solicitante (obrigatório) phonenumber telefone do solicitante (obrigatório) e mail e mail do solicitante (obrigatório) contractid número do contrato no 4biz (opcional) se não for informado, o 4biz vai incluir a solicitação vinculada ao contrato default parametrizado no serviço service dados do serviço (opcional) se não for informado, o 4biz vai incluir a solicitação vinculada ao serviço default parametrizado no cadastro de webservice code código do serviço opcional, se nome do serviço for informado) name nome do serviço obrigatório quando o serviço não existir no 4biz e o atributo synchronize for igual a true category categoria do serviço obrigatório quando o serviço não existir no 4biz e o atributo synchronize for igual a true code código da categoria name nome da categoria urgency urgência da solicitação (opcional) valores possíveis h=alta, m=média, l=baixa se não for informada, a urgência será calculada partir dos parâmetros do catálogo de serviço do 4biz impact of request (opcional) valores possíveis h=alto, m=médio, l=baixo se não for informado, o impacto será calculado a partir dos parâmetros do catálogo de serviço do 4biz groupid sigla do grupo executor no 4biz (opcional) se não for informada, o grupo executor será obtido a partir dos parâmetros do catálogo de serviço do 4biz atributos de saída os atributos de saída são compostos de todos os atributos de entrada da classe ctrequest, mais as seguintes informações number número da solicitação criada no 4biz itsm startsla data e hora de início do sla endsla data e hora de término do sla status situação da solicitação, contendo code código da situação name nome da situação currenttask tarefa atual, contendo number número da tarefa name nome da tarefa startdatetime data e hora de início status situação da tarefa, contendo code código da situação name nome da situação userid login do usuário responsável pela tarefa groupid sigla do grupo responsável pela tarefa {"synchronize" true, "sourcerequest" {"numberorigin" "9999", "type" "r", "userid" " 61 84460708 ", " email " " fulano de tal\@centralit com br ", " department " " department of the so and so ", " name " " so and so "}, " description " " rest v3 ", " service " {" name " " service test 1 ", " category " {" name " " category 1 "}}, " contractid " " 1 ", " urgency " "h", "impact" "h"} } supondo que no atributo platform no login foi informado "usuário" e considerando o atributo synchronize igual a true, o 4biz irá \ verificar se existe um de para do contrato 1 para o "usuário"; \ incluir o solicitante no cadastro de usuários, caso não exista na base; \ incluir o serviço no catálogo de serviços do contrato 1, caso não exista na base e registrar o de para de serviços para o cliente; \ incluir a solicitação com número de origem 9999; \ registrar o de para da solicitação de origem 9999 para o cliente alteração de informações de um ticket (create) alterando informação de requisição/incidente url /services/request/create atributos de entrada ​​synchronize indica se as informações de usuário e/ou serviço serão sincronizadas request informações da solicitação origem da classe ctrequest, contendo numberorigin número da solicitação no sistema de origem obrigatório quando o atributo number não for informado description descrição do incidente ou requisição (opcional) userid identificação de usuário do solicitante (obrigatório) será incluído se não existir na base do 4biz e o atributo synchronize for igual a true number número da solicitação no 4biz (obrigatório) contact dados do solicitante obrigatório quando o solicitante não existir no 4biz e o atributo synchronize for igual a true) name nome do solicitante (obrigatório) phonenumber telefone do solicitante (obrigatório) e mail e mail do solicitante (obrigatório) ​ service dados do serviço (opcional) code código do serviço opcional, se nome do serviço for informado) name nome do serviço obrigatório quando o serviço não existir no 4biz e o atributo synchronize for igual a true category categoria do serviço obrigatório quando o serviço não existir no 4biz e o atributo synchronize for igual a true code código da categoria name nome da categoria urgency urgência da solicitação (opcional) valores possíveis h=alta, m=média, l=baixa se não for informada, a urgência será calculada partir dos parâmetros do catálogo de serviço do 4biz itsm impacto da solicitação (opcional) valores possíveis h=alto, m=médio, l=baixo se não for informado, o impacto será calculado a partir dos parâmetros do catálogo de serviço do 4biz itsm atributos de saída os mesmos que os atributos de entrada {"synchronize" true, "request" {"numberorigin" "9999", "userid" "ciclano de tal", "contact" {"phonenumber" "61 84460709", "email" "cyclone", "name" "cyclone of such"}, "description" "inclusion of request using rest v3 changed", "cyclano de tal\@centralit com br", "department" "service" {"name" "servico teste 2", "category" {"name" "category 2"}}}} supondo que no atributo platform no login foi informado "usuário" e considerando o atributo synchronize igual a true, o 4biz irá incluir o solicitante no cadastro de usuários, caso não exista na base; incluir o serviço no catálogo de serviços do contrato 1, caso não exista na base e registrar o de para de serviços para o cliente; alterar o solicitante e serviço da solicitação com número de origem 9999 alteração da situação de um ticket (updatestatus) alteração da situação de um incidente/requisição url /services/request/updatestatus pré requisitos ir na tela de operação webservice e configurar com o grupo autorizado a executar esse webservice request updatestatus ir na tela de operação webservice e configurar o parâmetro id justificativa padrão para alteração da situação, com o código de um motivo de suspensão de atividade o usuário poderá realizar o comando select from justificativasolicitacao para conseguir o código a ser informado no parâmetro descrito acima atributos de entrada ​​number informar o número de criação do ticket; synchronize true ou false, utilize true para informar que deseja sincronizar o ticket; status code – informar a situação do ticket, podendo ser \ in progess \ suspended \ canceled \ solved \ reopened \ closed details informar detalhes do porque o usuário está fazendo um update no ticket; atributos de saída os mesmos que os atributos de entrada {"numberorigin" "9999", "status" {"code" "suspended", "details" "integration testing"}} consultar tickets do solicitante (getbyuser) consultando incidentes e requisições do solicitante url /services/request/getbyuser atributos de entrada userid identificação de usuário do solicitante (obrigatório) description descrição do incidente ou requisição (opcional) startdate data de início da solicitação (opcional) enddate data de finalização da solicitação (opcional) service dados do serviço (opcional) code código do serviço name nome do serviço contractid número do contrato no 4biz (opcional) status situação da solicitação (opcional), contendo code código da situação valores possíveis em andamento, suspensa, cancelada, resolvida, reaberta, fechada, reclassificada atributos de saída coleção de objetos da classe ctrequest contendo number número da solicitação no 4biz itsm numberorigin número da solicitação no sistema de origem type tipo da solicitação valores possíveis i=incidente ou r=requisição description descrição do incidente ou requisição userid identificação de usuário do solicitante urgency urgência da solicitação (opcional) valores possíveis h=alta, m=média, l=baixa se não for informada, a urgência será calculada partir dos parâmetros do catálogo de serviço do 4biz groupid sigla do grupo executor no 4biz (opcional) se não for informada, o grupo executor será obtido a partir dos parâmetros do catálogo de serviço do 4biz startdatetime data e hora de início da solicitação startsla data e hora de início do sla endsla data e hora de término do sla status situação da solicitação, contendo code código da situação name nome da situação {"userid" "john elliot ", "startdate" "2015 09 16t03 00 00 000z", "enddate" "2015 09 19t03 00 00 000z"} detalhes do ticket de um solicitante (getbyid) detalhes da requisição/incidente url /services/request/getbyid atributos de entrada number número da solicitação no 4biz itsm obrigatório quando o atributo numberorigin não for informado numberorigin número da solicitação no sistema de origem obrigatório quando o atributo number não for informado atributos de saída atributos de saída são compostos de todos os atributos de entrada da classe ctrequest mais as seguintes informações number número da solicitação criada no 4biz startsla hora e data inicial do sla endsla hora e data final do sla status status da solicitação, contendo code código da situação name nome da situação currenttask tarefa atual, contendo number número da tarefa name nome da tarefa startdatetime hora e data inicial status situação da tarefa, contendo code código da situação name nome da situação userid login do usuário responsável pela tarefa groupid acrônimo do grupo responsável pela tarefa {"numberorigin" "9999"} incluir ocorrência no ticket (createoccurrence) inclui uma ocorrência em uma solicitação url /services/request/createoccurrence atributos de entrada requestnumber número da solicitação no 4biz obrigatório quando o atributo requestnumberorigin não for informado requestnumberorigin número da solicitação no sistema de origem obrigatório quando o atributo requestnumber não for informado ocurrence objeto da classe ctoccurrence, contendo numberorigin número da ocorrência no sistema de origem (opcional) description descrição da ocorrência date data de registro da ocorrência hour hora de registro da ocorrência no formato hh\ mm category categoria da ocorrência valores possíveis acompanhamento, atualização, diagnostico, investigação, memorando, informação, retorno, sintoma, contorno, agendamento reason motivo da ocorrência atributos de saída objeto da classe ctocurrence contendo number número da ocorrência no 4biz numberorigin número da ocorrência no sistema de origem description descrição da ocorrência date data de registro da ocorrência hour hora de registro da ocorrência no formato hh\ mm userid identificação do usuário responsável pelo registro da ocorrência origin origem da ocorrência valores possíveis email, fone fax, voice mail, pessoalmente, outros category categoria da ocorrência valores possíveis criacao, acompanhamento, atualizacao, diagnostico, investigacao, memorando, informacao, retorno, sintoma, contorno, execucao, mudancasla, reclassificacao, agendamento, suspensao, reabertura, direcionamento, compartilhamento, cancelamentotarefa, iniciosla, suspensaosla, aprovacao, reativacaosla elapsedtime tempo decorrido (para categoria do tipo execucao) reason – motivo da ocorrência task tarefa associada à ocorrência, contendo number número da tarefa name nome da tarefa startdatetime data e hora de início enddatetime data e hora de execução status situação da tarefa, contendo code código da situação name nome da situação userid login do usuário responsável pela execução da tarefa {"requestnumberorigin" "9999", "occurrence" {"description" "occurrence test","category" {"code" "workaround solution"}, "date" "2015 08 20t03 00 00 000z", "hour" "2219"}} consultar ocorrências do ticket (listoccurrences) consultar informações das solicitações/incidentes url /services/request/listoccurrences atributos de entrada requestnumber número da solicitação no 4biz obrigatório quando o atributo requestnumberorigin não for informado requestnumberorigin número da solicitação no sistema de origem obrigatório quando o atributo requestnumber não for informado atributos de saída objeto da classe ctocurrence containing number número do evento na 4biz numberorigin número da ocorrência no sistema de origem description descrição da ocorrência date data do registro da ocorrência hour hora para registrar a ocorrência no formato hh\ mm userid identificação do usuário responsável por registrar a ocorrência origin origem da ocorrência valores possíveis email, fone fax, voice mail, personally, others category categoria da ocorrência valores possibles creation, monitoring, update, diagnosis, investigation, memo, information, return, symptom, outline, executing, exchanging, reclaiming, reclassification, schedule, suspend, reopen, targeting, sharing, cancellation task, homesla, suspendedsla, approval, reactivationsla elapsedtime tempo gasto (para categoria do tipo de execução) reason – motivo da ocorrência task tarefa associada com a ocorrência, contendo number número da tarefa name nome da tarefa startdatetime hora e data inicial enddatetime hora e data da execução status status da tarefa, contendo code código da localização name nome da situação userid login do usuário responsável pela execução da tarefa {"requestnumberorigin" "9999"} listar tickets para atendimento esse webservice deve ser utilizado para listar os usuários que podem ser solicitantes na abertura de um ticket o solicitante deve estar vinculado à um grupo que tenha permissão de criar em um fluxo de trabalho listar requisições/incidentes para atendimento url /services/request/createoccurrence /webmvc/servicerequestincident/searchtickets possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 406 not acceptable business exception atributos de entrada sessionid atributo obrigatório que recebe o código da sessão; name atributo não obrigatório que recebe o nome do solicitante, parte do nome; &#x9; se o usuário passar a informação %%%, o sistema retornará todos os solicitantes do sistema • userid atributo obrigatório que recebe o código do usuário logado; • selectedpage atributo obrigatório que passa a página a ser traga; • passar o sessionid no header; • filtros permitidos nesse webservice, os atributos descritos abaixo não são obrigatórios o attendantid atributo que permite filtrar pelo nome do atendente; o groupid atributo que permite filtrar pelo nome do grupo; o orderby atributo que permite ordenar os registros pelos seguintes parâmetros  ticket id número do ticket,  create date data de criação,  limit date data limite para atendimento do ticket, o orderdirection atributo que permite direcionar os tickets de duas formas  asc direciona pelo número do ticket de forma crescente,  desc direciona pelo número do ticket de forma decrescente o requesterid atributo que permite filtrar pelo nome do solicitante; o status atributo que permite filtrar pelas situações dos tickets  in progress,  suspended,  canceled,  solved,  closed o ticketid atributo que permite filtrar pelo número do ticket; o unitid atributo que permite filtrar pelo nome da unidade; exemplo de entrada no webservice { "userid" 4, "selectedpage" 1 } exemplo de entrada no webservice com os atributos não obrigatórios { "userid" 4, "selectedpage" 1, "attendantid" 0, "groupid" 0, "orderby" "ticket id", "orderdirection" "asc", "requesterid" 0, "selectedpage" 0, "status" "in progress", "ticketid" 0, "unitid" 0 } { "sessionid" "39738a39 836d 4940 94d5 c9235035bb29", "name" "poll" } exemplo de entrada no webservice com atributos não obrigatórios { "userid" 4, "selectedpage" 1, "attendantid" 0, "groupid" 0, "orderby" "ticket id", "orderdirection" "asc", "requesterid" 0, "selectedpage" 0, "status" "in progress", "ticketid" 0, "unitid" 0 } atributos de saída " id " – resposta que retorna o código do solicitante encontrado pela pesquisa; &#x9;“name” resposta que retorna o nome do solicitante; &#x9;"email" – resposta que retorna o endereço de e mail do solicitante; &#x9;“unit” – resposta que retorna id código da unidade; name nome da unidade; “places” – resposta que retorna id código da localidade; name nome da localidade; “phone” – resposta que retorna o número do telefone do solicitante; • "id" – resposta que retorna o número do ticket; • “tipo” resposta que retorna o tipo de demanda, ou seja, se é uma requisição (r), incidente (i) ou procedimento(p); • "nomeprioridade" – resposta que retorna o nome da prioridade dada ao ticket; • “solicitacao” – resposta que retorna a descrição da atividade solicitada; • “tarefa” – resposta que retorna a tarefa do fluxo que se encontra o ticket; • “status” – resposta que retorna a situação da tarefa do ticket listado; • “datalimite” – resposta que retorna a data e a hora de encerramento da solicitação de serviço conforme o sla e calendário vinculado a atividadexcontrato • “statusfluxonome” resposta que retorna a situação do sla, podendo ser normal, a vencer, vencido, suspenso exemplo de resposta válida do webservice "code" "200", "message" "request processed successfully", "payload" { "initialnumber" 1, "lastpage" 1 0, "finalnumber" 20, "totalrequests" 168, "result" \[ "id" 1251, "tipo" "incidente", "nomeprioridade" "medium", "solicitacao" "serviço de incidente", "tarefa" "atender solicitacao", "status" "normal", "datalimite" "2020 06 09 09 18 00 am utc" ] } { &#x9; "status" "success", &#x9; "code" "200", &#x9; "message" "request processed successfully", &#x9; "payload" \[ &#x9; { &#x9; "id" 904, &#x9; "name" "lucas novais", &#x9; "email" "lucas\@rogalabs com", &#x9; "unit" { &#x9; "id" 1, &#x9; "name" "default", &#x9; "places" \[ &#x9; { &#x9; "id" 1, &#x9; "name" "brasilia" &#x9; } &#x9; ] &#x9; }, &#x9; "phone" "(676) 76868 7687" &#x9; } &#x9; ] &#x9;} gravar ticket em atendimento esse webservice deve ser utilizado para retornar os tickets para atendimento dos analistas pré condições possuir acesso ao sistema e permissão de execução no fluxo de trabalho gravar ticket em atendimento url para apenas gravar o ticket webmvc/servicerequestincident/save para gravar e avançar o ticket webmvc/servicerequestincident/next possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 406 not acceptable business exception atributos de entrada authentication token atributo obrigatório que recebe o token de autenticação passar o authentication token no header; servicerequestid atributo obrigatório que recebe o número do ticket; taskid atributo obrigatório que recebe o número da tarefa do ticket; contactemail atributo obrigatório que recebe o endereço de e mail do solicitante; contactextension atributo não obrigatório que recebe o número do ramal do telefone do solicitante; contactphone atributo não obrigatório que recebe o número do telefone do solicitante; goupid atributo não obrigatório que recebe o número do código do grupo que poderá receber o ticket; statusid atributo obrigatório que recebe o número do código da situação que o ticket receberá após a gravação do ticket, sendo esses status &#x9;in progress (1), canceled (3) or resolved (4) originid atributo não obrigatório que recebe o número do código de origem que o ticket receberá após a gravação do ticket; causeid atributo não obrigatório que recebe o número do código de causa de solução que o ticket receberá após a gravação do ticket; idsolutioncategory atributo não obrigatório que recebe o número do código de categoria de solução que o ticket receberá após a gravação do ticket; response atributo não obrigatório que recebe a descrição da solução resposta que o ticket receberá após a gravação do ticket; builderobjects atributo não obrigatório que recebe as respostas capturadas caso, o ticket possua um formulário no ticket; quiz atributo não obrigatório que recebe as respostas capturadas caso, o ticket possua um questionário no ticket; flowaction atributo que recebe a ação de usuário desenhada no fluxo e respondida pelo atendente para solução do ticket; reasonflowaction atributo que recebe a resposta dada ao campo motivo, quando essa é desenhada no fluxo como obrigatória; exemplo de entrada no webservice { "servicerequestid" 5409, &#x9;"taskid" 8342, &#x9;"contactemail" "teste\@teste com", &#x9;"contactextension" "4979", &#x9;"contactphone" "(64)999177012", &#x9;"goupid" 21, &#x9;"statusid" 1, &#x9;"originid" 59, &#x9;"causeid" 7, &#x9;"idsolutioncategory" 13, &#x9;"response" "teste de gravação via webservice", } atributos de saída " idgrupoatual " – resposta que retorna o código do grupo atual do ticket; “idtarefa” resposta que retorna o código da tarefa do ticket; " idstatus" – resposta que retorna o código da atual situação do ticket; “status” – resposta que retorna a descrição do status do ticket; “datahorainicio” – resposta que retorna a data e hora de criação do ticket; “datahorainiciosla” – resposta que retorna a data e hora de início do sla do ticket; “datahoralimite” – resposta que retorna a data e hora de encerramento do sla do ticket; “datahorasolicitacao” resposta que retorna a data e hora de criação do ticket; descrição resposta que retorna a descrição do ticket; idcategoriasolucao resposta que retorna o código da categoria de solução do ticket; idcausaincidente resposta que retorna o código da causa de solução do ticket; idcontrato resposta que retorna o código do contrato do ticket; idservico resposta que retorna o código do serviço de negócio ou apoio do ticket; idsolicitacaoservico resposta que retorna o número do ticket; idsolicitante resposta que retorna o código do solicitante do ticket; idunidade resposta que retorna o código da unidade do ticket, impacto resposta que retorna a sigla do impacto; resposta resposta que retorna dos dizeres da solução resposta; siglagrupo resposta que retorna a sigla do grupo; tarefa resposta que retorna a descrição da tarefa; urgencia resposta que retorna a sigla da urgência do ticket; idusuarioresponsavelatual resposta que retorna o código do responsável do ticket; nomegrupoatual resposta que retorna a descrição do grupo atual do ticket; solicitantevip resposta que retorna se o solicitante é vip ou não, respostas possíveis false ou true { "status" "success", &#x9;"code" "200", &#x9;"message" "request processed successfully", &#x9;"payload" { &#x9; "idgrupoatual" 171, &#x9; "idtarefa" 8809, &#x9; "idstatus" 1, &#x9; "status" "in progress", &#x9; "datahorainicio" "2020 09 10 11 58 28 am brt", &#x9; "datahorainiciosla" "2020 09 10 11 58 29 am brt", &#x9; "datahoralimite" "2020 09 10 17 08 00 pm brt", &#x9; "datahorasolicitacao" "2020 09 10 11 58 28 am brt", &#x9; "descricao" "\<div>test\</div>", &#x9; "idcategoriasolucao" 13, &#x9; "idcausaincidente" 7, &#x9; "idcontrato" 52, &#x9; "idservico" 670, &#x9; "idsolicitacaoservico" 5712, &#x9; "idsolicitante" 456, &#x9; "idunidade" 2, &#x9; "impacto" "a", &#x9; "resposta" "teste de gravação via webservice", &#x9; "siglagrupo" "level1", &#x9; "tarefa" "answer ticket", &#x9; "urgencia" "a", &#x9; "idusuarioresponsavelatual" 254, &#x9; "nomegrupoatual" "level 1", &#x9; "solicitantevip" false &#x9;} } receber unidades esse webservice deve ser utilizado para retornar as unidades ativas existentes no sistema para seleção na criação de um ticket pré condições esse webservice sofre alteração de resultados caso o parâmetro 61 vincula contratos a unidade (ex s ou n) esteja ativo a documentação de desenvolvimento está no swagger exemplo https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ para ler essa documentação, é preciso estar logado na aplicação, e essa aplicação precisa estar na versão que possui esses webservices receber unidades url webmvc/ v1/unit método get possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 404 – justificativa não encontrada atributos de entrada • authentication token atributo obrigatório que recebe o token de autenticação o passar o authentication token no header; • employeeid atributo obrigatório que recebe o código do usuário solicitante do ticket o passar o atributo como parâmetro; • limit atributo que retorna a quantidade de unidades a serem retornadas na pesquisa; o passar o atributo como parâmetro; • unitquery atributo não obrigatório que permite pesquisar por parte do nome da unidade; o passar o atributo como parâmetro; exemplo de entrada no webservice { não se aplica uma vez que a url passará todos os atributos necessários } atributos de saída • id retorna o código da unidade; • name retorna a descrição da unidade; exemplo de saída no webservice { "status" "success", "code" "200", "message" "request processed successfully", "payload" \[ { "id" 52, "name" " human resourcer" } ] } receber justificativa de suspensão esse webservice deve ser utilizado para retornar as justificativas de suspensão cadastradas e ativas no sistema pré condições o usuário que é passado no webservice deve possuir permissão de suspender no fluxo de trabalho; a documentação de desenvolvimento está no swagger exemplo https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ para ler essa documentação, o usuário precisa estar logado na aplicação, e essa aplicação precisa estar na versão que possui esses webservices receber justificativa de suspensão url webmvc/v1/ticket/justification método get possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 404 – justificativa não encontrada atributos de entrada • authentication token atributo obrigatório que recebe o token de autenticação o passar o authentication token no header; • type atributo obrigatório que recebe uma das siglas abaixo o passar o type como parâmetro; o type (s = suspension, a = approval) available values s, a default value s exemplo de entrada no webservice { não se aplica uma vez que a url passará todos os atributos necessários } atributos de saída • id retorna o código da justificativa de suspensão; • description retorna a descrição da justificativa de suspensão exemplo de saída no webservice { "status" "success", "code" "200", "message" "request processed successfully", "payload" \[ { "id" 1, "description" "default" } ] } listar tickets para atendimento esse webservice deve ser utilizado para retornar as opções permitidas no fluxo em um determinado grupo pré condições o usuário que é passado no webservice precisa possuir acesso ao sistema o usuário que é passado no webservice deve possuir permissão no fluxo de trabalho; a documentação de desenvolvimento está no swagger exemplo https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ para ler essa documentação, o usuário precisa estar logado na aplicação, e essa aplicação precisa estar na versão que possui esses webservices listar tickets para atendimento url /webmvc/v1/ticket/{ticketid}/permissions método get possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 404 – ticket not found atributos de entrada • authentication token atributo obrigatório que recebe o token de autenticação o passar o authentication token no header; • taskid atributo obrigatório que recebe o número da tarefa do ticket; o passar o taskid como parâmetro na url; • ticketid atributo obrigatório que recebe o número do ticket; exemplo de entrada no webservice { não se aplica uma vez que a url passará todos os atributos necessários } atributos de saída • "id" – resposta que retorna o número do ticket; • “tipo” resposta que retorna o tipo de demanda, ou seja, se é uma requisição (r), incidente (i) ou procedimento(p); • "nomeprioridade" – resposta que retorna o nome da prioridade dada ao ticket; • “solicitacao” – resposta que retorna a descrição da atividade solicitada; • “tarefa” – resposta que retorna a tarefa do fluxo que se encontra o ticket; • “status” – resposta que retorna a situação da tarefa do ticket listado; • “datalimite” – resposta que retorna a data e a hora de encerramento da solicitação de serviço conforme o sla e calendário vinculado a atividadexcontrato • “statusfluxonome” resposta que retorna a situação do sla, podendo ser normal, a vencer, vencido, suspenso exemplo de resposta válida do webservice "code" "200", "message" "request processed successfully", "payload" { "initialnumber" 1, "lastpage" 1 0, "finalnumber" 20, "totalrequests" 168, "result" \[ "id" 1251, "tipo" "incidente", "nomeprioridade" "medium", "solicitacao" "serviço de incidente", "tarefa" "atender solicitacao", "status" "normal", "datalimite" "2020 06 09 09 18 00 am utc" ] } receber ações de usuário em um ticket esse webservice deve ser utilizado para retornar as ações de usuário desenhadas em um fluxo de trabalho pré condições o usuário que é passado no webservice precisa possuir acesso ao sistema o usuário que é passado no webservice deve possuir permissão de execução no fluxo de trabalho; a documentação de desenvolvimento está no swagger exemplo https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ para ler essa documentação, o usuário precisa estar logado na aplicação, e essa aplicação precisa estar na versão que possui esses webservices receber ações de usuário em um ticket url webmvc/v1/ticket/{ticketid}/flow actions método get possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 404 – ticket não encontrado pós condição para enviar a resposta selecionada na ação de usuário, utilize o webservice de gravar e avançar (webmvc/servicerequestincident/next) atributos "flowaction" "reasonflowaction" atributos de entrada • authentication token atributo obrigatório que recebe o token de autenticação o passar o authentication token no header; • taskid atributo obrigatório que recebe o número da tarefa do ticket; o passar o taskid como parâmetro na url; • ticketid atributo obrigatório que recebe o número do ticket; exemplo de entrada no webservice { não se aplica uma vez que a url passará todos os atributos necessários } atributos de saída • "id código da ação de fluxo cadastrada no desenho de fluxo; • name nome da ação de fluxo; • description descrição da ação de fluxo; • requiresreason informa se o motivo é obrigatório, existe duas respostas para esse atributo o true quando o motivo for obrigatório; o false quando o motivo não for obrigatório; • approvalactionid retorna o código da resposta de aprovação; • ticketstatusid retorna o código da situação do ticket; { "status" "success", "code" "200", "message" "request processed successfully", "payload" \[ { "id" 1302, "name" "approveticket", "description" "approve ticket", "requiresreason" false, "approvalactionid" 1, "ticketstatusid" 1 }, { "id" 1304, "name" "denyticket", "description" "deny ticket", "requiresreason" false, "approvalactionid" 2, "ticketstatusid" 3 } ] } listar anexos dos tickets esse webservice deve ser utilizado para retornar a lista dos anexos de um tickets para atendimento dos analistas pré condições o usuário que é passado no webservice precisa possuir acesso ao sistema a documentação de desenvolvimento está no swagger exemplo https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ https //presentation02 citsmartcloud com/4biz/webmvc/swagger ui html#/ para ler essa documentação, o usuário precisa estar logado na aplicação, e essa aplicação precisa estar na versão que possui esses webservices observação esse documento contém todos os webservices necessários para anexo que inclui listar anexos de um ticket; realizar download do anexo; anexar documento ao ticket (upload); deletar anexo do ticket listar anexos dos tickets url /webmvc/servicerequestincident/{servicerequestincidentid}/attachments método tipo get possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 404 ticket not found atributos de entrada • authentication token atributo que recebe o token de acesso à aplicação o o token deve ser passado no header; • servicerequestincidentid atributo obrigatório que recebe o número do ticket; o o número do ticket deve ser passado no path, junto à url; exemplo de entrada no webservice { não se aplica, veja que os atributos de entrada estão no header e no path da url } atributos de saída • "id" – resposta que retorna o código do anexo contido no ticket; • “name” resposta que retorna a descrição do anexo; • "extension" – resposta que retorna a extensão do anexo; exemplo de resposta válida do webservice { "status" "success", "code" "200", "message" "request processed successfully", "payload" \[ { "id" 2253, "name" "ei 1598697802049 png png", "extension" "png" }, { "id" 2252, "name" "ei 1598697788434 jpg jpg", "extension" "jpg" }, { "id" 2251, "name" "ei 1598697777801 jpg jpg", "extension" "jpg" } ] } realizar download de anexos de um ticket realizar download de anexos de um ticket url webmvc/servicerequestincident/{servicerequestincidentid}/attachments/{documentid} método tipo get possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 404 document or ticket not found atributos de entrada • authentication token atributo que recebe o token de acesso à aplicação o o token deve ser passado no header; • servicerequestincidentid atributo obrigatório que recebe o número do ticket; o o número do ticket deve ser passado no path, junto à url; • documentid atributo obrigatório que recebe o código do anexo contido no ticket; o o id do anexo deve ser passado no path, junto à url; exemplo de entrada no webservice { não se aplica, veja que os atributos de entrada estão no header e no path da url } atributos de saída o próprio anexo exemplo de resposta válida do webservice { não se aplica } upload anexos dos tickets upload anexos dos tickets url /services/request/addattachments método tipo post pré condição 1\ verificar os parâmetros 2\ 44 diretório upload repositório path (ex windows c /temp) 3\ 278 tamanho máximo de arquivo, em bytes, para upload default\[1073741824] = 1gb 4\ 318 lista de extensões de arquivos que não poderão ser anexados (para mais de uma extensão separar por ponto e vírgula) 5\ 446 enviar anexos no e mail de notificação do ticket? (ex s ou n default 'n') possíveis códigos de retorno 200 – requisição efetuada com sucesso 500 – campos obrigatórios não informados atributos de entrada • mediatype atributo obrigatório que indica o formato da conversa o importante deixar fixo em application/json • requestnumber atributo obrigatório que recebe o número da requisição que receberá o anexo; • attachments lista de arquivo; • name atributo obrigatório que recebe o nome do arquivo; • content atributo obrigatório que deverá estar codificado em base64 que recebe o conteúdo do arquivo; o o content é o conteúdo do arquivo codificado em base64; • extension atributo obrigatório que recebe a extensão do arquivo txt, jpg, jpeg, exemplo de entrada no webservice { &#x9; "sessionid" "b7f24d64 5e23 4331 ab89 63403cb00d40", &#x9; "mediatype" "application/json", &#x9; "requestnumber" "1351", &#x9; "attachments" \[{ &#x9; "name" "arquivo teste", &#x9; "content" "vgvzdgu=", &#x9; "extension" "txt" &#x9; }] } atributos de saída • datetime atributo obrigatório que indica data e hora de execução; • datetimemilliseconds hora em milissegundos; • operationid número da operação que foi realizada; • error atributo obrigatório que indica se houve erro durante a execução do webservice; exemplo de resposta válida do webservice { "datetime" "2020 05 19 14 56 00", "datetimemilliseconds" 1589910960717, "operationid" 603, "error" null } deleta anexos dos tickets deleta anexos dos tickets url /webmvc/v1/ticket/{ticketid}/attachments/{documentid} método tipo delete possíveis códigos de retorno 200 – requisição efetuada com sucesso 401 invalid authentication token or user without access to the resource 404 ticket not found atributos de entrada • authentication token atributo que recebe o token de acesso à aplicação o o token deve ser passado no header; • servicerequestincidentid atributo obrigatório que recebe o número do ticket; o o número do ticket deve ser passado no path, junto à url; • documentid atributo obrigatório que recebe o código do anexo contido no ticket; o o id do anexo deve ser passado no path, junto à url; exemplo de entrada no webservice { não se aplica, veja que os atributos de entrada estão no header e no path da url } atributos de saída { não se aplica } exemplo de resposta válida do webservice { "status" "success", "code" "200", } filtrar conhecimento deleta anexos dos tickets url /webmvc/v1/knowledge base/indexed método tipo get documentação técnica link do swagger /webmvc/swagger ui html#/knowledge%20base/searchusingget o webservice apresentado permite filtrar os conhecimentos pelo título possíveis códigos de retorno 1\ 200 success 2\ 401 invalid authentication 3\ 404 ticket not found atributos de entrada • authentication token atributo obrigatório que recebe o código de autenticação do login • currentpage atributo do tipo integer com valor default 1 • limit atributo do tipo integer com valor defaul 20 • searchkeyword atributo do tipo string atributos de saída • " status " – resposta que retorna o status do serviço ; • “code” resposta com o código de retorno; • " message " – resposta que apresenta a mensagem do código de retorno; • “payload” – resposta que apresenta idbaseconhecimento e título; exemplo de resposta válida do webservice { "status" "success", "code" "200", "message" "request processed successfully", "payload" \[ { "idbaseconhecimento" 555, "titulo" "applications instalation" } detalhar conhecimento, listar anexos e visualizar a quantidade de like e dislike do conhecimento deleta anexos dos tickets url /webmvc/v1/knowledgebase/{knowledgebaseid} método tipo get documentação técnica /webmvc/swagger ui html#/knowledge%20base/findusingget o webservice apresentado permite visualizar um conhecimento, listar os seus anexos e ver a quantidade de like e dislikes do seu conteúdo possíveis códigos de retorno 1\ 200 success 2\ 401 invalid authentication 3\ 404 ticket not found atributos de entrada • authentication token atributo obrigatório que recebe o código de autenticação do login • knowledgebaseid atributo que recebe o número do ticket exemplo de entrada no webservice { &#x9;" authentication token " " eyjhbgcioijiuzuxmij9 eyjlehaioje2mdgxndk2mjcsim5hbwuioijdbgllbnrpbmuilcjjb250cm9sijoin2iymjy5nzaymjnhmjizmtm4mzkyztm2mmuzmzm1mmuzmjmwmziymjjjmji2odzmnzm3ndiym2eymjmxmzgzotjlmzyyztmzmzuyztmymzazmjiyn2qilcjpc3n1zwrbdci6mtywode0njaynzizncwibg9jywxlijoizw4ilcjjbgllbnrfawqioij1bmtub3duiiwidgltzw91dci6mzywmcwidxnlcm5hbwuioijjbgllbnqwmsj9 zefn lp00hgtp5ojwtmuiiqinxxnks9vzy28tepqskgubydib9gxh33sjpyxrd v9brocdudzoi7m6umlegefq", } atributos de saída • " status " – resposta que retorna o status do serviço ; • “code” resposta com o código de retorno; • " message " – resposta que apresenta a mensagem do código de retorno; “payload” – resposta que apresenta título, contente, version, totallike, totalunlike, liked, unliked, usercreated, lastpublicationdate, userupdated, attachments exemplo de resposta válida do webservice { "status" "success", "code" "200", "message" "request processed successfully", "payload" { "title" "applications instalation", "content" "\<p>applications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalationapplications instalation\</p>\n", "version" "1 0", "totallike" 1, "totalunlike" 0, "liked" false, "unliked" false, "usercreated" "consultant", "lastpublicationdate" "2020 04 01 06 22 14 am brt", "userupdated" "vinny gravito", "attachments" \[ { "id" 606, "name" "app instalation pdf", "extension" "pdf" } ] } } download de anexos deleta anexos dos tickets url /webmvc/v1/knowledgebase/{knowledgebaseid}/attachments/{documentid} método tipo get documentação técnica link do swagger /webmvc/swagger ui html#/knowledge%20base/downloadattachmentsusingget o webservice apresentado permite fazer download de anexos listados em um conhecimento possíveis códigos de retorno &#x9; 200 success &#x9; 401 invalid authentication &#x9; 404 ticket not found atributos de entrada • authentication token atributo obrigatório que recebe o código de autenticação do login • knowledgebaseid atributo que recebe o número do ticket exemplo de entrada no webservice { &#x9; " authentication token " " eyjhbgcioijiuzuxmij9 eyjlehaioje2mdgxndk2mjcsim5hbwuioijdbgllbnrpbmuilcjjb250cm9sijoin2iymjy5nzaymjnhmjizmtm4mzkyztm2mmuzmzm1mmuzmjmwmziymjjjmji2odzmnzm3ndiym2eymjmxmzgzotjlmzyyztmzmzuyztmymzazmjiyn2qilcjpc3n1zwrbdci6mtywode0njaynzizncwibg9jywxlijoizw4ilcjjbgllbnrfawqioij1bmtub3duiiwidgltzw91dci6mzywmcwidxnlcm5hbwuioijjbgllbnqwmsj9 zefn lp00hgtp5ojwtmuiiqinxxnks9vzy28tepqskgubydib9gxh33sjpyxrd v9brocdudzoi7m6umlegefq", } enviar like e dislike deleta anexos dos tickets url /webmvc/v1/knowledgebase/{knowledgebaseid}/vote/{type} método tipo post documentação técnica link do swagger /webmvc/swagger ui html#/knowledge base/voteusingpost o webservice apresentado permite dar like e dislike em um conteúdo do portal do conhecimento possíveis códigos de retorno &#x9; 200 success &#x9; 401 invalid authentication &#x9; 404 ticket not found atributos de entrada • authentication token atributo obrigatório que recebe o código de autenticação do login • knowledgebaseid atributo que recebe o número do ticket • type atributo que recebe o tipo de voto exemplo de entrada no webservice { &#x9; " authentication token " " eyjhbgcioijiuzuxmij9 eyjlehaioje2mdgxndk2mjcsim5hbwuioijdbgllbnrpbmuilcjjb250cm9sijoin2iymjy5nzaymjnhmjizmtm4mzkyztm2mmuzmzm1mmuzmjmwmziymjjjmji2odzmnzm3ndiym2eymjmxmzgzotjlmzyyztmzmzuyztmymzazmjiyn2qilcjpc3n1zwrbdci6mtywode0njaynzizncwibg9jywxlijoizw4ilcjjbgllbnrfawqioij1bmtub3duiiwidgltzw91dci6mzywmcwidxnlcm5hbwuioijjbgllbnqwmsj9 zefn lp00hgtp5ojwtmuiiqinxxnks9vzy28tepqskgubydib9gxh33sjpyxrd v9brocdudzoi7m6umlegefq", }