List global materials

get

https://api.operations1.app/tenants/{tenantId}/global-materials

List all global materials. The result is paginated. The query parameters customId and location do not match exactly, but are used as a substring search in the relevant properties. The query parameter search is used as a substring search in the name property.

Path Params

tenantId

string

required

length between 1 and 100

Consists of the subdomain. The tenantId for https://company.operations1.app/ is company.

Query Params

pageSize

integer

required

10 to 200

Defaults to 10

pageIndex

required

≥ 0

archived

boolean

lang

string

enum

string

length ≥ 3

customId

string

length ≥ 3

location

string

length ≥ 3

classCharacteristicIds

array of integers

Array of ids of all selected class characteristics. This is the central parameter for filtering by class characteristics.

classCharacteristicIds

includeParentClassCharacteristics

boolean

includeChildrenClassCharacteristics

boolean

classCharacteristicsCombination

string

enum

Allowed:

Headers

accept-version

required

Defines the API version. Using a date is recommended for stability. Avoid using latest in production, as it refers to the most up-to-date functionality, which may include breaking changes. For more details, see our article on versioning.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

401This error ist returned if authentication of the request was not successful. For more information read our article about authentication.

403This error is returned if you do not have the necessary permissions for the endpoint.

429This error is returned if your request was not executed due to rate limit. For more information read our article about rate limiting.

defaultGeneral errors