Hydraulikdatenbank

User Authentication

In order to access the listed endpoints you need to send an API token with each request. You have the option to provide your token with one of the following methods.

Type Parameter Example
Query api_token ?api_token=F7CB3tr8T7r0jAy0osVJWVUg0Nd5jBNq
Header Authorization Authorization: Bearer F7CB3tr8T7r0jAy0osVJWVUg0Nd5jBNq
Header Authorization Authorization: Basic dXNlcm5hbWU6RjdDQjN0cjhUN3IwakF5MG9zVkpXVlVnME5kNWpCTnE=1
1 Base64 encoded string consisting of the username and password separated by a colon (e.g. username:F7CB3tr8T7r0jAy0osVJWVUg0Nd5jBNq)

Components

A component is a reusable element that can appear once or several times within a drawing.

Method URI
GET, HEAD /api/component
GET, HEAD /api/component/{component}
Overview of available service endpoints to retrieve components

Route: /api/component

Lists all components ordered by their ID. If the cursor query parameter is given the returned collection will only contain those components whose ID is larger than the given value.

Type Parameter Data Type Note
Query cursor integer ID of the component to start from.
Query limit integer Total number of components to retrieve.
Query include string A comma separated list of relations to include
(available: group)
Overview of available parameters to customize the result of the service endpoint

Route: /api/component/{component}

Returns a component with the given ID.

Type Parameter Data Type Note
Route component integer ID of the component to retrieve.
Query include string A comma separated list of relations to include
(available: group)
Overview of available parameters to customize the result of the service endpoint

Groups

A group puts individual components together in one umbrella term. A group consists of one or several components, but a component belongs to a single group only.

Method URI
GET, HEAD /api/group
GET, HEAD /api/group/{group}
Overview of available service endpoints to retrieve groups

Route: /api/group

Lists all component groups ordered by their ID. If the cursor query parameter is given the returned collection will only contain those groups whose ID is larger than the given value.

Type Parameter Data Type Note
Query cursor integer ID of the group to start from.
Query limit integer Total number of groups to retrieve.
Query include string A comma separated list of relations to include
(available: components)
Overview of available parameters to customize the result of the service endpoint

Route: /api/group/{group}

Returns a component group with the given ID.

Type Parameter Data Type Note
Route group integer ID of the group to retrieve.
Query include string A comma separated list of relations to include
(available: components)
Overview of available parameters to customize the result of the service endpoint

Drawings

A drawing is a mechanical figure that consists of multiple components.

Method URI
GET, HEAD /api/drawing
GET, HEAD /api/drawing/{drawing}
GET, HEAD /api/drawing/search
Overview of available service endpoints to retrieve drawings

Route: /api/drawing

Lists all drawings ordered by their ID. If the cursor query parameter is given the returned collection will only contain those drawings whose ID is larger than the given value.

Type Parameter Data Type Note
Query cursor integer ID of a drawing to start from.
Query limit integer Total number of drawings to retrieve.
Query include string A comma separated list of relations to include
(available: components, components.group, groups)
Overview of available parameters to customize the result of the service endpoint

Route: /api/drawing/{drawing}

Returns a drawing with the given ID.

Type Parameter Data Type Note
Route drawing integer ID of the drawing to retrieve.
Query include string A comma separated list of relations to include
(available: components, components.group, groups)
Overview of available parameters to customize the result of the service endpoint

Route: /api/drawing/search

Search for drawings that contain specific components.

Example: /api/drawing/search/?q=component:not(id,1376):has(id,1296,amount,gte,1)

Type Parameter Data Type Note
Query q string Retrieve all drawings which match the given query.
Query cursor integer ID of a drawing to start from.
Query limit integer Total number of drawings to retrieve.
Query include string A comma separated list of relations to include
(available: components, components.group, groups)
Overview of available parameters to customize the result of the service endpoint