Equipamentos do Centro de Custo

• Listar
• Pegar
• Criar
• Atualizar
• Remover

Listar

Endpoint que lista todos os equipamentos cadastrados.

Parameters

costCenterIds: [1,2,3] (array) - "Filtra por Id do centro de custo"
_q: 'texto' (string) - "Busca os equipamentos cadastrados."
_sort: 'id' (string) ('id') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."

Response

{success} Response 200 (application/json)

{
    "items": [
        {
            "id": 1,
            "cost_center_id": 1,
            "usage_limit": 50,
            "equipment": {
                "id": 1,
                "name": "Equipamento x"
            },
            "group": {
                "id": 2,
                "name": "Grupo X"
            },
            "cost_composition_type": {
                "id": 2,
                "name": "Proporcional"
            }
        }
    ],
    "total": 1,
    "per_page": 10,
    "current_page": 1
}

{warning} Response 422 (application/json)

{
    "_sort": [
        "O campo sort selecionado é inválido."
    ],
    "_order": [
        "O campo order selecionado é inválido."
    ],
    "_limit": [
        "O campo limit deve ser um número inteiro."
    ],
    "_page": [
        "O campo page deve ser um número inteiro."
    ]
}

{primary} Response 204 (application/json).

Quando os critérios de parâmetros não contiver registros a serem retornados.

Pegar

Endpoint que pega um equipamento específico.

Parameters

id: 1 (integer) - "Id do cadastro de equipamento do centro de custo"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "cost_center_id": 1,
    "usage_limit": 50,
    "equipment": {
        "id": 1,
        "name": "Equipamento x"
    },
    "group": {
        "id": 2,
        "name": "Grupo X"
    },
    "cost_composition_type": {
        "id": 2,
        "name": "Proporcional"
    }
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Criar

Endpoint que adiciona um equipamento a um centro de custo.

Attributes

cost_center_id: 1 (integer, required) - "Id do centro de custo.",
equipment_id: 1 (integer, required) - "Id do equipamento.",
usage_limit: 50 (float | null) - "Limite de uso em porcentagem, entre -100 e 100.",
apportionment_group_id: 1 (integer) - "Id do Grupo de Equipamentos de Rateio",
cost_composition_type_id: 1 (integer) - "Id do Tipo de Composição de Custo. Quando não enviado irá cadastrar como opção 1 (Fixa)"

Response

{success} Response 201 (application/json)

{
    "id": 1,
    "cost_center_id": 1,
    "usage_limit": 50,
    "equipment": {
        "id": 1,
        "name": "Equipamento x"
    },
    "group": {
        "id": 2,
        "name": "Grupo X"
    },
    "cost_composition_type": {
        "id": 2,
        "name": "Proporcional"
    }
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Atualizar

Endpoint que atualiza um equipamento específico.

Parameters

id: 1 (integer) - "Id do cadastro de equipamento do centro de custo"

Attributes

cost_center_id: 1 (integer, required) - "Id do centro de custo.",
equipment_id: 1 (integer, required) - "Id do equipamento.",
usage_limit: 50 (float, required) - "Limite de uso em porcentagem, entre -100 e 100."
apportionment_group_id: 1 (integer) - "Id do Grupo de Equipamentos de Rateio",
cost_composition_type_id: 1 (integer) - "Id do Tipo de Composição de Custo. Quando não enviado irá cadastrar como opção 1 (Fixa)"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "cost_center_id": 1,
    "usage_limit": 50,
    "equipment": {
        "id": 1,
        "name": "Equipamento x"
    },
    "group": {
        "id": 2,
        "name": "Grupo X"
    },
    "cost_composition_type": {
        "id": 2,
        "name": "Proporcional"
    }
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Deletar

Endpoint que deleta um equipamento específico.

Parameters

id: 1 (integer) - "Id do cadastro de equipamento do centro de custo"

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.