Listar composições - API Pública

Requisição

Parâmetros Header

Authorization

string

requerido

Token gerado pelo OrçaFascio

Exemplo:

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.orcafascio.com/api/v1/base/mybase/compositions' \
--header 'Authorization: '

Respostas

🟢200success

application/json

Body

total

integer

requerido

Total de registros

per_page

integer

requerido

Total de registros por páginas

current_page

integer

requerido

Número da páginal atual

records

array [object {12}]

requerido

Objetos das composições

id

string

requerido

ID da composicão

user_id

string

requerido

ID da usuário "dono"

company_id

string

requerido

ID da empresa

department_id

string

requerido

ID do setor

group_id

string

requerido

ID do grupo

code

string

requerido

Código da composicão

second_code

string | null

opcional

Segundo código do insumo "Opcional"

description

string

requerido

Descrição da composicão

type

string

requerido

Tipo da composicão

unit

string

requerido

Unidade da composicão

is_sicro

boolean

requerido

created_at

string

requerido

Data de criação da composicão

Exemplo

{
    "total": 2,
    "per_page": 10,
    "current_page": 1,
    "records": [
        {
            "id": "65d7d151f43197d18ac07432",
            "company_id": "62683e8363051f543020cfe5",
            "user_id": "62683e8363051f543020cfe9",
            "department_id": "62683e8363051f543020cfe8",
            "code": "00000001",
            "second_code": null,
            "description": "Copia da SINAPI (74210/001) - BARRACAO PARA DEPOSITO EM TABUAS DE MADEIRA, COBERTURA EM FIBROCIMENTO 4 MM,  INCLUSO PISO ARGAMASSA TRAÇO 1:6 (CIMENTO E AREIA)",
            "type": "CANT",
            "unit": "m²",
            "is_sicro": false,
            "created_at": "2024-02-22T19:57:21.933-03:00"
        },
        {
            "id": "65d7d1dff43197c7dec07433",
            "company_id": "62683e8363051f543020cfe5",
            "user_id": "62683e8363051f543020cfe9",
            "department_id": "62683e8363051f543020cfe8",
            "code": "00000002",
            "second_code": null,
            "description": "IUSP0002",
            "type": "SERP",
            "unit": "M",
            "is_sicro": false,
            "created_at": "2024-02-22T19:59:43.078-03:00"
        }
    ]
}

🟠401Not authorized

🔴500Internal server error