Skip to content
REST API Reference/
/
Creates a new job type.

Willow Public API (v3)

Download OpenAPI description
willow-api.json
willow-api.yaml
Languages
Servers
https://{instance}.app.willowinc.com/api/v3

OAuth2

Authentication is required prior to accessing the Willow API. Refer to Authentication section above for details.

Operations

Models

Models endpoints are used for getting the models and their details.

Operations

Twins

The Twins endpoints enable creating, updating, and fetching one or more twins at a time. When receiving twins, there are also options to include relationships in the same response.

Operations

Relationships

Relationship endpoints enable creating, updating, and fetching relationship details.

Operations

Time Series

The Time Series endpoints are used for sending or receiving telemetry data. Once a Capability twin has been created that represents the time series, the telemetry associated with that twin can be created using either the twin's dtId (aka twinId) or externalId, a timestamp, and a value. Data is transmitted as an array so time series data can be batched and sent within a single request. Similarly, time series can be retreived for one or more Capability twins at a time using the twinId(s).

Operations

Insights

Insights are issues, opportunities, or knowledge that can help optimize or improve the performance of a building. They can be associated with any twin within Willow and are triggered in real-time by Skills that are running within Willow's Activate Technology and analyzing the incoming time series data.

Operations

Events

Events endpoints enable creating, updating, and deleting discrete occurrences such as Weather Forecast, Calendar events etc.

Operations

Tickets

This API group is in pre-release and may change without notice. Use with caution. Breaking changes may occur as development continues.
Tickets endpoints enable creating, updating and retrieving Tickets.

Operations

Ticket Metadata

This API group is in pre-release and may change without notice. Use with caution. Breaking changes may occur as development continues.
Ticket Metadata endpoints enable creating, updating and retrieving Ticket Metadata.

Operations

Retrieves a paginated list of categories based on the batch request

Request

Returns a paginated list of the possible categories that a ticket can have.

Security
oauth2
Body
required
sortSpecificationsArray of objects(SortSpecification)
filterSpecificationsArray of objects(FilterSpecification)
pagenull or integer(int32)
pageSizenull or integer(int32)
{
  "sortSpecifications": [
    { … }
  ],
  "filterSpecifications": [
    { … }
  ],
  "page": null,
  "pageSize": null
}

Responses

List of paginated ticket categories.

Bodyapplication/json
beforeinteger(int32)
afterinteger(int32)
totalinteger(int32)
itemsArray of objects(TicketCategory)
Response
application/json
{
  "before": 0,
  "after": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Create new category

Request

Security
oauth2
Body
required
namenull or string[ 0 .. 80 ] charactersrequired

Gets or sets the name of the ticket category.

locationsArray of strings or null

Gets or sets the list of locations associated with the ticket category.

{
  "name": null,
  "locations": null
}

Responses

Created

Bodyapplication/json
idstring(uuid)

Gets or sets the ticket category id.

namenull or string

Gets or sets the category name.

isActiveboolean

Gets or sets a value indicating whether the category is active or not.

locationsArray of strings or null

Gets or sets the list of locations associated with the ticket category.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": null,
  "isActive": true,
  "locations": null
}

Update existing category

Request

Security
oauth2
Path
categoryIdstring(uuid)required
Body
required
namenull or string[ 0 .. 80 ] characters

Gets or sets the category name.

isActivenull or boolean

Gets or sets a value indicating whether the category is active or not.

locationsArray of strings or null

Gets or sets the list of locations associated with the ticket category.

{
  "name": null,
  "isActive": null,
  "locations": null
}

Responses

OK

Bodyapplication/json
idstring(uuid)

Gets or sets the ticket category id.

namenull or string

Gets or sets the category name.

isActiveboolean

Gets or sets a value indicating whether the category is active or not.

locationsArray of strings or null

Gets or sets the list of locations associated with the ticket category.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": null,
  "isActive": true,
  "locations": null
}

Retrieves a paginated list of job types based on the batch request

Request

Returns a paginated list of the possible job types that a ticket can have.

Security
oauth2
Body
required
sortSpecificationsArray of objects(SortSpecification)
filterSpecificationsArray of objects(FilterSpecification)
pagenull or integer(int32)
pageSizenull or integer(int32)
{
  "sortSpecifications": [
    { … }
  ],
  "filterSpecifications": [
    { … }
  ],
  "page": null,
  "pageSize": null
}

Responses

Paginated ticket job types list.

Bodyapplication/json
beforeinteger(int32)
afterinteger(int32)
totalinteger(int32)
itemsArray of objects(TicketJobType)
Response
application/json
{
  "before": 0,
  "after": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Creates a new job type.

Request

Security
oauth2
Body
required
namenull or string[ 0 .. 500 ] charactersrequired

Gets or sets the job type name.

{
  "name": null
}

Responses

Created

Bodyapplication/json
idstring(uuid)

Gets or sets the unique identifier for the job type.

namenull or string

Gets or sets the name of the job type.

isActiveboolean

Gets or sets a value indicating whether JobType is active.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": null,
  "isActive": true
}

Updates an existing job type

Request

Security
oauth2
Path
jobTypeIdstring(uuid)required
Body
required
namenull or string[ 0 .. 500 ] characters

Gets or sets the job type name.

isActivenull or boolean

Gets or sets a value indicating whether the job type is active.

{
  "name": null,
  "isActive": null
}

Responses

OK

Bodyapplication/json
idstring(uuid)

Gets or sets the unique identifier for the job type.

namenull or string

Gets or sets the name of the job type.

isActiveboolean

Gets or sets a value indicating whether JobType is active.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": null,
  "isActive": true
}

Retrieves a paginated list of service needed based on the batch request

Request

Returns a paginated list of the possible services needed that a ticket can have.

Security
oauth2
Body
required
sortSpecificationsArray of objects(SortSpecification)
filterSpecificationsArray of objects(FilterSpecification)
pagenull or integer(int32)
pageSizenull or integer(int32)
{
  "sortSpecifications": [
    { … }
  ],
  "filterSpecifications": [
    { … }
  ],
  "page": null,
  "pageSize": null
}

Responses

List of paginated service needed.

Bodyapplication/json
beforeinteger(int32)
afterinteger(int32)
totalinteger(int32)
itemsArray of objects(TicketServiceNeeded)
Response
application/json
{
  "before": 0,
  "after": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Creates a new service needed entry based on the provided request.

Request

Security
oauth2
Body
required
namenull or string[ 0 .. 500 ] charactersrequired

Gets or sets the name of the service needed.

categoryIdnull or string(uuid)

Gets or sets the category Id of the service needed.

locationsArray of strings or null

Gets or sets the space twin Ids associated with the service needed.

{
  "name": null,
  "categoryId": null,
  "locations": null
}

Responses

Created

Bodyapplication/json
idstring(uuid)

Gets or sets the unique identifier for the service needed.

namenull or string

Gets or sets the name of the service needed.

categoryIdnull or string(uuid)

Gets or sets the category Id of the service needed.

locationsArray of strings or null

Gets or sets the locations associated with the service needed.

isActiveboolean

Gets or sets a value indicating whether service needed is active or not.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": null,
  "categoryId": null,
  "locations": null,
  "isActive": true
}

Update service needed entry based on the provided request.

Request

Security
oauth2
Path
serviceNeededIdstring(uuid)required

The ID of the service needed.

Body
required
namenull or string[ 0 .. 500 ] characters

Gets or sets the name of the service needed.

categoryIdnull or string(uuid)

Gets or sets the category Id of the service needed.

isActivenull or boolean

Gets or sets a value indicating whether the service needed is active.

locationsArray of strings or null

Gets or sets the space twin Ids associated with the service needed.

{
  "name": null,
  "categoryId": null,
  "isActive": null,
  "locations": null
}

Responses

OK

Bodyapplication/json
idstring(uuid)

Gets or sets the unique identifier for the service needed.

namenull or string

Gets or sets the name of the service needed.

categoryIdnull or string(uuid)

Gets or sets the category Id of the service needed.

locationsArray of strings or null

Gets or sets the locations associated with the service needed.

isActiveboolean

Gets or sets a value indicating whether service needed is active or not.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": null,
  "categoryId": null,
  "locations": null,
  "isActive": true
}

Retrieves a list of ticket status.

Request

Security
oauth2
No request payload

Responses

List of ticket status.

Bodyapplication/jsonArray [
idstring(uuid)

Gets or sets the unique identifier for the ticket status.

namenull or string

Gets or sets the name of the ticket status.

tabnull or string

Gets or sets the status's tab that can be used to filter ticket status in UI.

colornull or string

Gets or sets the color associated with the ticket status.

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": null,
    "tab": null,
    "color": null
  }
]

Retrieves a list of the ticket priorities

Request

Security
oauth2
No request payload

Responses

List of ticket priorities.

Bodyapplication/jsonArray [
idstring(uuid)

Gets or sets the unique identifier for the ticket priority.

namenull or string

Gets or sets the name of the ticket priority.

priorityLevelany

Gets or sets the priority level of the ticket.

Enum"urgent""high""medium""low"
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": null,
    "priorityLevel": "urgent"
  }
]
Copyright © 2024 Willow. All rights reserved.