API Reference

Scalars

Roles

Common objects

Slots

Projects

Services

Bookings

Spaces

Locations

Assets

Team

Reviews

Reminders

Webhooks

Denylist

Schema

JS SDK

Timerise © 2024

Assets overview

An asset may be an item needed to perform the service, e.g. specialized equipment.

Object types

Asset

type Asset {
	projectId: ID!
	assetId: ID!
	shortId: NonEmptyString!
	title: NonEmptyString!
	location: Location
	description: String
	slots: [Slot]
	media: [Media]
	labels: [NonEmptyString]
	createdAt: DateTime!
	updatedAt: DateTime!
}

Asset fields

AssetSlotStrategy

type AssetSlotStrategy {
	projectId: ID!
	assetId: ID!
	strategyId: ID!
	strategyType: StrategyType!
	discontinueStrategy: DiscontinueStrategy!
	dateTimeFrom: DateTime
	dateTimeTo: DateTime
	timeFrom: Time
	timeTo: Time
	daysOfWeek: [DayOfWeek]
	slotType: SlotType
	slotQuantity: NonNegativeInt
	slotDuration: Duration
	slotInterval: Duration
	createdAt: [DateTime](<https://timerise.notion.site/DateTime-d906acb0a1e4492ab960a2fa5d4650ab>)!
	updatedAt: [DateTime](<https://timerise.notion.site/DateTime-d906acb0a1e4492ab960a2fa5d4650ab>)!
}

AssetSlotStrategy fields

Queries

assets

assets(
	projectId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
	locationId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)
	limit: [NonNegativeInt](<https://timerise.notion.site/NonNegativeInt-04116d7c1f2a47fb82756b93ba6d0d50>)
	cursor: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)
): [[Asset](<https://timerise.notion.site/058b4d4b91974486a7c73e3b1bd64eef>)]

assets arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

assetsSearch

assetsSearch(
	projectId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
	query: String!
	locationId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)
): [[Asset](<https://timerise.notion.site/058b4d4b91974486a7c73e3b1bd64eef>)]

assetsSearch arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

assetSlotsStrategies

assetSlotsStrategies(
	projectId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
	assetId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
): [[AssetSlotStrategy](<https://timerise.notion.site/b0935ec956954880ae7ea0daf89a7654>)]

assetSlotsStrategies arguments

<aside> 🔑 Minimal role required: ADMIN / APIADMIN

</aside>

Mutations

assetCreate

assetCreate(
	projectId: ID!
	locationId: ID
	title: NonEmptyString
	description: String
	media: [MediaInput]
	labels: [NonEmptyString]
): Asset

assetCreate arguments

<aside> 🔑

Minimal role required: MANAGER

</aside>

assetUpdate

assetUpdate(
	projectId: ID!
	assetId: ID!
	locationId: ID
	title: NonEmptyString
	description: String
	media: [MediaInput]
	labels: [NonEmptyString]
): Asset

assetUpdate arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

assetDelete

assetDelete(
	projectId: ID!
	assetId: ID!
): [String](<https://timerise.notion.site/String-cbd380ec65db4815b2a3e1dc61d2b734>)

assetDelete arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

assetSlotCreate

assetSlotCreate(
	projectId: ID!
	assetId: ID!
	quantity: NonNegativeInt!
	dateTimeFrom: DateTime!
	dateTimeTo: DateTime!
	slotType: SlotType!
	slotGroupId: ID
	title: NonEmptyString
): Slot

assetSlotCreate arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

assetSlotUpdate