Sablono API (1.2.0)

Download OpenAPI specification:Download

The Sablono API for exporting data from the sablono platform into your own database or reporting software. All reports are generated once a day and cached for 24 hours. You can request the content in json or csv format.

Authentication

API_Key

Authentication and Authorization is handled by api keys. To get an api key contact the Sablono support team and request a key for a given project.

Security scheme type: API Key
Header parameter name: Authorization

Deliverable

A deliverable (also known as unit, project element or component) is the container for a process where a process is a collection of activities connected through dependencies. In a project you will find hundreds or even thousands of deliverables. Many share a common process.

Deliverables are used as reporting units and usually reflect physical elements like rooms, walls, deliverys or payment units.

List deliverables

This endpoint returns the list of deliverables of the project.

(Support for json and csv)

Authorizations:
path Parameters
project_id
required
string <uuid> (uuid) 36 characters Nullable ^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$

The unique identifier of the project you are requesting a resource for.

Responses

200

successful

Response Schema: application/json
meta
required
object (request_metadata)

Common information about the response

deliverables
required
Array of objects (deliverable)

Collection of deliverables

400

Bad Request: Malformed project id supplied.

401

Unauthorized: Invalid api token supplied.

404

Not Found: Invalid project id supplied.

get /{project_id}/deliverables

Production server

https://api.sablono.com/reporting/{project_id}/deliverables

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "deliverables":
    [
    ]
}

Activity

An activity (also known as task) is a time consuming action where progress and quality is reported for. In a project you will find thousands of activities which are connected thorough dependencies. This connected set of activities is used to derive a project schedule.

List activities

This endpoint returns the list of activities of the project.

(Support for json and csv)

Authorizations:
path Parameters
project_id
required
string <uuid> (uuid) 36 characters Nullable ^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$

The unique identifier of the project you are requesting a resource for.

Responses

200

successful

Response Schema: application/json
meta
object (request_metadata)

Common information about the response

activities
Array of objects (activity)

Collection of activities

400

Bad Request: Malformed project id supplied.

401

Unauthorized: Invalid api token supplied.

404

Not Found: Invalid project id supplied.

get /{project_id}/activities

Production server

https://api.sablono.com/reporting/{project_id}/activities

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "activities":
    [
    ]
}

Checklist

A checklist (also known as check sheet) is the digital equivalent of the traditional quality control forms filled out on the jobsite. A checklist would contain the list of items to be reviewed during your Quality Assurance process.

A checklist is requested by an activity once it reaches a certain state.

List checklists

This endpoint returns the list of checklists of the project.

(Support for json and csv)

Authorizations:
path Parameters
project_id
required
string <uuid> (uuid) 36 characters Nullable ^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$

The unique identifier of the project you are requesting a resource for.

Responses

200

successful

Response Schema: application/json
meta
object (request_metadata)

Common information about the response

checklists
Array of objects (checklist)

Collection of checklists

400

Bad Request: Malformed project id supplied.

401

Unauthorized: Invalid api token supplied.

404

Not Found: Invalid project id supplied.

get /{project_id}/checklists

Production server

https://api.sablono.com/reporting/{project_id}/checklists

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "checklists":
    [
    ]
}

Cost Package

A cost package (also known as cost group or cost frame) is usually a contractual unit that needs to be payed once certain milestones of progress are reached.

In Sablono this means that a cost group wraps a collection of activities which by default hold the progress. Each type of activity is partially contributing to the total budget of the group.

List cost packages

This endpoint returns the list of cost packages of the project.

(Support for json and csv)

Authorizations:
path Parameters
project_id
required
string <uuid> (uuid) 36 characters Nullable ^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$

The unique identifier of the project you are requesting a resource for.

Responses

200

successful

Response Schema: application/json
meta
required
object (request_metadata)

Common information about the response

cost_packages
required
Array of objects (cost_package)

Collection of cost packages

400

Bad Request: Malformed project id supplied.

401

Unauthorized: Invalid api token supplied.

404

Not Found: Invalid project id supplied.

get /{project_id}/cost-packages

Production server

https://api.sablono.com/reporting/{project_id}/cost-packages

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "cost_packages":
    [
    ]
}

Note

A note (also known as comment or mark) is a quality reporting mechanism (snagging) of the platform. Notes are always attached to deliverables. To be more specific very often notes are attached to activities and checklist items, too.

List notes

This endpoint returns the list of notes of the project.

(Support for json and csv)

Authorizations:
path Parameters
project_id
required
string <uuid> (uuid) 36 characters Nullable ^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$

The unique identifier of the project you are requesting a resource for.

Responses

200

successful

Response Schema: application/json
meta
required
object (request_metadata)

Common information about the response

notes
required
Array of objects (note)

Collection of notes

400

Bad Request: Malformed project id supplied.

401

Unauthorized: Invalid api token supplied.

404

Not Found: Invalid project id supplied.

get /{project_id}/notes

Production server

https://api.sablono.com/reporting/{project_id}/notes

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "notes":
    [
    ]
}

Image

Images are mainly used to attach them to notes. But also other resources can reference an image.

File

Files are the downloadable entities of the platform. For example: image, pdf, csv or svg.

Download file

This endpoint lets you download files like images, pictures, documents, etc.

Authorizations:
path Parameters
project_id
required
string <uuid> (uuid) 36 characters Nullable ^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$

The unique identifier of the project you are requesting a resource for.

id
required
integer <int64>

The resource identifier

Responses

200

successful

Response Schema:
string <binary> (file)
400

Bad Request: Malformed project id supplied.

401

Unauthorized: Invalid api token supplied.

404

Not Found: Unknown resource id provided.

get /{project_id}/files/{id}

Production server

https://api.sablono.com/reporting/{project_id}/files/{id}