Table of Contents
Objeto de manutenção
Os seguintes objetos estão diretamente relacionados à API de maintenance.
Manutenção
O objeto de manutenção possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| maintenanceid | ID | ID da manutenção. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| name | string | Nome da manutenção. Comportamento da propriedade: - obrigatório para operações de criação |
| active_since | timestamp | Hora em que a manutenção se torna ativa (inclusive). O valor fornecido será arredondado para baixo para minutos. Comportamento da propriedade: - obrigatório para operações de criação |
| active_till | timestamp | Hora em que a manutenção deixa de estar ativa (exclusive). O valor fornecido será arredondado para baixo para minutos. Comportamento da propriedade: - obrigatório para operações de criação |
| description | string | Descrição da manutenção. |
| maintenance_type | integer | Tipo de manutenção. Valores possíveis: 0 - (padrão) com coleta de dados; 1 - sem coleta de dados. |
| tags_evaltype | integer | Método de avaliação de tags de problema. Valores possíveis: 0 - (padrão) E/Ou; 2 - Ou. |
Período de tempo
O objeto de período de tempo é usado para definir períodos em que a manutenção deve entrar em vigor. Ele possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| period | integer | Duração do período de manutenção em segundos. O valor fornecido será arredondado para baixo para minutos. Padrão: 3600. |
| timeperiod_type | integer | Tipo de período de tempo. Valores possíveis: 0 - (padrão) apenas uma vez; 2 - diariamente; 3 - semanalmente; 4 - mensalmente. |
| start_date | timestamp | Data em que o período de manutenção deve entrar em vigor. O valor fornecido será arredondado para baixo para minutos. Padrão: data atual. Comportamento da propriedade: - suportado se timeperiod_type estiver definido como "apenas uma vez" |
| start_time | integer | Hora do dia em que a manutenção começa em segundos. O valor fornecido será arredondado para baixo para minutos. Padrão: 0. Comportamento da propriedade: - suportado se timeperiod_type estiver definido como "diariamente", "semanalmente" ou "mensalmente" |
| every | integer | Para períodos diários e semanais, every define os intervalos de dia ou semana nos quais a manutenção deve entrar em vigor.Valor padrão se timeperiod_type estiver definido como "diariamente" ou "semanalmente": 1.Para períodos mensais quando day está definido, a propriedade every define o dia do mês em que a manutenção deve entrar em vigor.Valor padrão se timeperiod_type estiver definido como "mensalmente" e day estiver definido: 1.Para períodos mensais quando dayofweek está definido, a propriedade every define a semana do mês em que a manutenção deve entrar em vigor.Valores possíveis se timeperiod_type estiver definido como "mensalmente" e dayofweek estiver definido:1 - (padrão) primeira semana; 2 - segunda semana; 3 - terceira semana; 4 - quarta semana; 5 - última semana. Comportamento da propriedade: - suportado se timeperiod_type estiver definido como "diariamente", "semanalmente" ou "mensalmente" |
| dayofweek | integer | Dias da semana em que a manutenção deve entrar em vigor. Valores possíveis de bitmap: 1 - Segunda-feira; 2 - Terça-feira; 4 - Quarta-feira; 8 - Quinta-feira; 16 - Sexta-feira; 32 - Sábado; 64 - Domingo. Este é um campo de máscara de bits; qualquer soma dos valores possíveis de bitmap é aceitável (por exemplo, 21 para Segunda, Quarta e Sexta-feira). Comportamento da propriedade: - obrigatório se timeperiod_type estiver definido como "semanalmente" ou se timeperiod_type estiver definido como "mensalmente" e day não estiver definido |
| day | integer | Dia do mês em que a manutenção deve entrar em vigor. Comportamento da propriedade: - obrigatório se timeperiod_type estiver definido como "mensalmente" e dayofweek não estiver definido |
| month | integer | Meses em que a manutenção deve entrar em vigor. Valores possíveis de bitmap: 1 - Janeiro; 2 - Fevereiro; 4 - Março; 8 - Abril; 16 - Maio; 32 - Junho; 64 - Julho; 128 - Agosto; 256 - Setembro; 512 - Outubro; 1024 - Novembro; 2048 - Dezembro. Este é um campo de máscara de bits; qualquer soma dos valores possíveis de bitmap é aceitável (por exemplo, 585 para Janeiro, Abril, Julho e Outubro). Comportamento da propriedade: - obrigatório se timeperiod_type estiver definido como "mensalmente" |
Tag de problema
O objeto de tag de problema é usado para definir quais problemas devem ser suprimidos quando a manutenção entrar em vigor. As tags só podem ser especificadas se o maintenance_type do objeto Maintenance estiver definido como "com coleta de dados". Possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| tag | string | Nome da tag do problema. Comportamento da propriedade: - obrigatório |
| operator | integer | Operador de condição. Valores possíveis: 0 - Igual; 2 - (padrão) Contém. |
| value | string | Valor da tag do problema. |