Indisponibilidade de Equipamento
indisponibilidade-equipamento/audit/:indisponibilidade-equipamento-id
Obter informações de interações no registro de Indisponibilidade de Equipamento
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/audit/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamentoAudits": {
"description": "Auditoria",
"type": "@ManyOf",
"schema": {
"created": "Data\/Hora",
"description": "Alterações",
"authorUser": {
"description": "Auditoria",
"type": "@OneOf",
"schema": {
"id": "Código",
"name": "Nome"
}
}
}
},
"total": "Total de Registros",
"page": "Página Carregada",
"pages": "Total de Páginas",
"pagination": "Páginação"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/collection
Coleção de Indisponibilidade de Equipamento com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. indisponibilidadeEquipamento.id, indisponibilidadeEquipamento.created, indisponibilidadeEquipamento.updated, integrationStatus.name, branch.name, indisponibilidadeEquipamento.internalKey, indisponibilidadeEquipamento.occurrence, indisponibilidadeEquipamento.operatorCpf, indisponibilidadeEquipamento.responseProtocol",
"order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC",
"filter-id": "Código",
"filter-created-start": "Data de Cadastro",
"filter-created-end": "Data de Cadastro",
"filter-updated-start": "Data de Atualização",
"filter-updated-end": "Data de Atualização",
"filter-integrationStatus-id": "Situação",
"filter-branch-id": "Filial",
"filter-internalKey-contains": "Identificador do Registro",
"filter-occurrence-start": "Data\/Hora de Ocorrência",
"filter-occurrence-end": "Data\/Hora de Ocorrência",
"filter-operatorCpf-contains": "CPF do Operador",
"filter-responseProtocol-contains": "Protocolo de Resposta"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamentos": {
"description": "Indisponibilidade de Equipamento",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"internalKey": "Identificador do Registro",
"occurrence": "Data\/Hora de Ocorrência",
"operatorCpf": "CPF do Operador",
"responseProtocol": "Protocolo de Resposta"
}
},
"total": "Total de Registros",
"page": "Página Carregada",
"pages": "Total de Páginas",
"pagination": "Páginação",
"order-by": "Atributo de Ordenação",
"order-type": "Tipo de Ordenação"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/create
Criar um(a) Indisponibilidade de Equipamento. Transmitir um evento para cada indisponibilidade e retorno à normalidade de cada equipamento definido. Não considerar indisponibilidades do tipo “house keeping”, casos de manutenção preventiva, rápida e, muitas vezes, diária de equipamentos.
POST
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"internalKey": "Identificador do Registro precisa ser um texto, Identificador do Registro é obrigatório, Identificador do Registro precisa ter 80 caracteres",
"occurrence": "Data\/Hora de Ocorrência precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Ocorrência é obrigatório",
"operatorCpf": "CPF do Operador precisa ter apenas dígitos, CPF do Operador é obrigatório, CPF do Operador precisa ter 11 caracteres",
"geoEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"available": "Disponivel precisa ser verdadeiro ou falso, Disponivel é obrigatório",
"datetimeAvailableForecast": "Previsão de Disponibilidade precisa ser data e hora (Y-m-d H:i:s)",
"reason": "Motivo de Indisponibilidade precisa ser um texto, Motivo de Indisponibilidade precisa ter 100 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/delete/:indisponibilidade-equipamento-id
Deletar Indisponibilidade de Equipamento
DELETE
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/delete/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/edit/:indisponibilidade-equipamento-id
Editar um(a) Indisponibilidade de Equipamento. Transmitir um evento para cada indisponibilidade e retorno à normalidade de cada equipamento definido. Não considerar indisponibilidades do tipo “house keeping”, casos de manutenção preventiva, rápida e, muitas vezes, diária de equipamentos.
POST
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/edit/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"internalKey": "Identificador do Registro precisa ser um texto, Identificador do Registro é obrigatório, Identificador do Registro precisa ter 80 caracteres",
"occurrence": "Data\/Hora de Ocorrência precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Ocorrência é obrigatório",
"operatorCpf": "CPF do Operador precisa ter apenas dígitos, CPF do Operador é obrigatório, CPF do Operador precisa ter 11 caracteres",
"geoEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"available": "Disponivel precisa ser verdadeiro ou falso, Disponivel é obrigatório",
"datetimeAvailableForecast": "Previsão de Disponibilidade precisa ser data e hora (Y-m-d H:i:s)",
"reason": "Motivo de Indisponibilidade precisa ser um texto, Motivo de Indisponibilidade precisa ter 100 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/get/:indisponibilidade-equipamento-id
Obter Indisponibilidade de Equipamento com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/get/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"internalKey": "Identificador do Registro",
"occurrence": "Data\/Hora de Ocorrência",
"operatorCpf": "CPF do Operador",
"responseProtocol": "Protocolo de Resposta",
"geoEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"available": "Disponivel",
"datetimeAvailableForecast": "Previsão de Disponibilidade",
"reason": "Motivo de Indisponibilidade",
"indisponibilidadeEquipamentoIntegration": {
"description": "Integração",
"type": "@ManyOf",
"schema": {
"id": "Código",
"sentDatetime": "Data\/Hora",
"sentUrl": "URL",
"sentMethod": "Método",
"sentAuthToken": "Autenticação",
"sentBody": "Mensagem de Envio",
"responseStatus": "Status de Resposta",
"responseBody": "Mensagem de Resposta",
"responseProtocol": "Protocolo de Resposta",
"retry": "Nova Tentativa"
}
}
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message