API Reference
Scalars
Roles
Common objects
Slots
Projects
Services
Bookings
Spaces
Locations
Assets
Team
Reviews
Reminders
Webhooks
Denylist
Schema
JS SDK
Timerise © 2022
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!
}| Field name | Value type | Non-null | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | |
shortId | NonEmptyString | true | |
title | NonEmptyString | true | |
location | Location | false | |
description | String | false | |
slots | [Slot] | false | |
media | [Media] | false | |
labels | [NonEmptyString] | false | |
createdAt | DateTime | true | The date and time when an asset was created. |
updatedAt | DateTime | true | The date and time when an asset was updated. |
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!
updatedAt: DateTime!
}| Field name | Value type | Non-null | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
strategyId | ID | true | A globally-unique identifier. |
strategyType | StrategyType | true | |
discontinueStrategy | DiscontinueStrategy | true | |
dateTimeFrom | DateTime | false | |
dateTimeTo | DateTime | false | |
timeFrom | Time | false | |
timeTo | Time | false | |
daysOfWeek | [DayOfWeek] | false | |
slotType | SlotType | false | |
slotQuantity | NonNegativeInt | false | |
slotDuration | Duration | false | |
slotInterval | Duration | false | |
createdAt | DateTime | true | The date and time when an object was created. |
updatedAt | DateTime | true | The date and time when an object was updated. |
Queries
assets
assets(
projectId: ID!
locationId: ID
limit: NonNegativeInt
cursor: ID
): [Asset]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | false | |
limit | NonNegativeInt | false | |
cursor | ID | false |
Minimal role required:
STAFFassetsSearch
assetsSearch(
projectId: ID!
query: String!
locationId: ID
): [Asset]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
query | String | true | |
locationId | ID | false | A globally-unique identifier. |
Minimal role required:
STAFFassetSlotsStrategies
assetSlotsStrategies(
projectId: ID!
assetId: ID!
): [AssetSlotStrategy]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
Minimal role required:
ADMIN / APIADMINMutations
assetCreate
assetCreate(
projectId: ID!
locationId: ID
title: NonEmptyString
description: String
media: [MediaInput]
labels: [NonEmptyString]
): Asset| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | false | A globally-unique identifier. |
title | NonEmptyString | false | |
description | NonEmptyString | false | |
media | [MediaInput] | false | |
labels | [NonEmptyString] | false |
Minimal role required:
MANAGERassetUpdate
assetUpdate(
projectId: ID!
assetId: ID!
locationId: ID
title: NonEmptyString
description: String
media: [MediaInput]
labels: [NonEmptyString]
): Asset| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
locationId | ID | false | A globally-unique identifier. |
title | NonEmptyString | false | |
description | String | false | |
media | [MediaInput] | false | |
labels | [NonEmptyString] | false |
Minimal role required:
MANAGERassetDelete
assetDelete(
projectId: ID!
assetId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERassetSlotCreate
assetSlotCreate(
projectId: ID!
assetId: ID!
quantity: NonNegativeInt!
dateTimeFrom: DateTime!
dateTimeTo: DateTime!
slotType: SlotType!
slotGroupId: ID
title: NonEmptyString
): Slot| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
quantity | NonNegativeInt | true | |
dateTimeFrom | DateTime | true | |
dateTimeTo | DateTime | true | |
slotType | SlotType | true | |
slotGroupId | ID | false | A globally-unique identifier. |
title | NonEmptyString | false |
Minimal role required:
MANAGERassetSlotUpdate
assetSlotUpdate(
projectId: ID!
assetId: ID!
slotId: String!
quantity: NonNegativeInt
dateTimeFrom: DateTime
dateTimeTo: DateTime
slotType: SlotType
title: NonEmptyString
slotGroupId: ID
): Slot| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | |
slotId | ID | true | |
quantity | NonNegativeInt | false | |
dateTimeFrom | DateTime | false | |
dateTimeTo | DateTime | false | |
slotType | SlotType | false | |
title | NonEmptyString | false | |
slotGroupId | ID | false |
Minimal role required:
MANAGERassetSlotDelete
assetSlotDelete(
projectId: ID!
assetId: ID!
slotId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
slotId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERassetSlotStrategyCreate
assetSlotStrategyCreate(
projectId: ID!
assetId: ID!
slotType: SlotType!
slotQuantity: NonNegativeInt!
slotDuration: Duration!
slotInterval: Duration!
strategyType: StrategyType!
discontinueStrategy: DiscontinueStrategyInput!
daysOfWeek: [DayOfWeek!]
dateTimeFrom: DateTime
dateTimeTo: DateTime
timeFrom: Time
timeTo: Time
): AssetSlotStrategy| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
slotType | NonNegativeInt | true | |
slotQuantity | ID | true | A globally-unique identifier. |
slotDuration | Duration | true | |
slotInterval | Duration | true | |
strategyType | StrategyType | true | |
discontinueStrategy | DiscontinueStrategyInput | true | |
daysOfWeek | [DayOfWeek] | true | |
dateTimeFrom | DateTime | false | |
dateTimeTo | DateTime | false | |
timeFrom | Time | false | |
timeTo | Time | false |
Minimal role required:
ADMIN / APIADMINassetSlotStrategyDelete
assetSlotStrategyDelete(
projectId: ID!
assetId: ID!
strategyId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
assetId | ID | true | A globally-unique identifier. |
strategyId | ID | true | A globally-unique identifier. |
Minimal role required:
ADMIN / APIADMIN