Authentication is required prior to accessing the Willow API. Refer to Authentication section above for details.
- Retrieves a ticket attachment by its Id.
Willow Public API (v3)
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).
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.
- application/json
- text/json
- application/*+json
Create ticket request.
Gets or sets the diagnostics associated with the ticket.
Specifies the type of assignee for a ticket.
Gets or sets the external created date of the ticket. This field represents the created date of the ticket in an external system.
Gets or sets the external updated date of the ticket. This field represents the last updated date of the ticket in an external system.
Gets or sets the external id of the ticket. This field represents the id of the ticket in an external system.
Gets or sets the list of property keys that can be extended and searched.
Gets or sets the list of ticket's recommendations.
- https://{instance}.app.willowinc.com/api/v3/tickets
- Payload
- JS
- C#
- Java
- Python
{ "summary": "string", "description": "string", "cause": "string", "solution": "string", "twinId": "string", "notes": "string", "latitude": 0.1, "longitude": 0.1, "insightId": "e0b109ff-077c-4d58-916e-b128cab16ecb", "insightName": "string", "diagnostics": [ { … } ], "reporter": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "creator": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "assigneeType": "noAssignee", "userAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "workgroupAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "dueDate": "2019-08-24T14:15:22Z", "externalCreatedDate": "2019-08-24T14:15:22Z", "externalUpdatedDate": "2019-08-24T14:15:22Z", "externalId": "string", "externalMetadata": "string", "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0", "jobTypeId": "e7fed64c-d7a0-4b92-b323-987c8904a687", "serviceNeededId": "1aa099e5-6900-4be9-91d2-38308a317250", "subStatusId": "c9b6af8c-39fe-4426-a105-7343d1ed54d3", "statusId": "e900225c-0629-4e96-be6e-86a17a309645", "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c", "tasks": [ { … } ], "customProperties": { "property1": "string", "property2": "string" }, "extendableSearchablePropertyKeys": [ "string" ], "recommendations": [ { … } ], "ticketCosts": [ { … } ] }
Ticket created.
Gets or sets the description of the underlying reason or cause associated with this instance.
Specifies the type of assignee for a ticket.
Specifies the available data source types for queries and operations.
Gets or sets the date when the ticket was created in an external system.
Gets or sets the date when the ticket was last updated in an external system.
Gets or sets the list of extendable searchable property keys associated with the ticket.
Gets or sets the list of ticket's recommendations.
Gets or sets the attachments associated with the ticket.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ticketPriority": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "priorityLevel": "urgent" }, "ticketStatus": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "tab": "string", "color": "string" }, "insightId": "e0b109ff-077c-4d58-916e-b128cab16ecb", "summary": "string", "description": "string", "cause": "string", "solution": "string", "reporter": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "assigneeType": "noAssignee", "userAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "workgroupAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "creator": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "dueDate": "2019-08-24T14:15:22Z", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "startedDate": "2019-08-24T14:15:22Z", "resolvedDate": "2019-08-24T14:15:22Z", "closedDate": "2019-08-24T14:15:22Z", "sourceType": "Adx", "sourceName": "string", "externalId": "string", "externalCreatedDate": "2019-08-24T14:15:22Z", "externalUpdatedDate": "2019-08-24T14:15:22Z", "latitude": 0.1, "longitude": 0.1, "customProperties": { "property1": "string", "property2": "string" }, "extendableSearchablePropertyKeys": [ "string" ], "scheduledDate": "2019-08-24T14:15:22Z", "occurrence": 0, "locations": [ { … } ], "twin": { "id": "string", "name": "string", "modelId": "string" }, "recommendations": [ { … } ], "category": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "jobType": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "serviceNeeded": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "subStatus": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "comments": [ { … } ], "attachments": [ { … } ], "ticketCosts": [ { … } ] }
- https://{instance}.app.willowinc.com/api/v3/tickets/{ticketId}
- Payload
- JS
- C#
- Java
- Python
No request payloadTicket found.
Gets or sets the description of the underlying reason or cause associated with this instance.
Specifies the type of assignee for a ticket.
Specifies the available data source types for queries and operations.
Gets or sets the date when the ticket was created in an external system.
Gets or sets the date when the ticket was last updated in an external system.
Gets or sets the list of extendable searchable property keys associated with the ticket.
Gets or sets the list of ticket's recommendations.
Gets or sets the attachments associated with the ticket.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ticketPriority": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "priorityLevel": "urgent" }, "ticketStatus": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "tab": "string", "color": "string" }, "insightId": "e0b109ff-077c-4d58-916e-b128cab16ecb", "summary": "string", "description": "string", "cause": "string", "solution": "string", "reporter": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "assigneeType": "noAssignee", "userAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "workgroupAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "creator": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "dueDate": "2019-08-24T14:15:22Z", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "startedDate": "2019-08-24T14:15:22Z", "resolvedDate": "2019-08-24T14:15:22Z", "closedDate": "2019-08-24T14:15:22Z", "sourceType": "Adx", "sourceName": "string", "externalId": "string", "externalCreatedDate": "2019-08-24T14:15:22Z", "externalUpdatedDate": "2019-08-24T14:15:22Z", "latitude": 0.1, "longitude": 0.1, "customProperties": { "property1": "string", "property2": "string" }, "extendableSearchablePropertyKeys": [ "string" ], "scheduledDate": "2019-08-24T14:15:22Z", "occurrence": 0, "locations": [ { … } ], "twin": { "id": "string", "name": "string", "modelId": "string" }, "recommendations": [ { … } ], "category": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "jobType": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "serviceNeeded": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "subStatus": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "comments": [ { … } ], "attachments": [ { … } ], "ticketCosts": [ { … } ] }
Request
This endpoint supports partial updates to a ticket using a JSON Patch document. The number of operations in the patch document must not exceed the number of updatable properties in the WorkflowCore.Controllers.Request.PatchTicketRequest model. Additionally, only "replace" operations are allowed.
- application/json
- text/json
- application/*+json
A Microsoft.AspNetCore.JsonPatch.JsonPatchDocument`1 containing the operations to apply to the ticket. Only "replace" operations are supported.
- https://{instance}.app.willowinc.com/api/v3/tickets/{ticketId}
- Payload
- JS
- C#
- Java
- Python
[ { "op": "string", "path": "string", "value": {} } ]
Ticket updated.
Gets or sets the description of the underlying reason or cause associated with this instance.
Specifies the type of assignee for a ticket.
Specifies the available data source types for queries and operations.
Gets or sets the date when the ticket was created in an external system.
Gets or sets the date when the ticket was last updated in an external system.
Gets or sets the list of extendable searchable property keys associated with the ticket.
Gets or sets the list of ticket's recommendations.
Gets or sets the attachments associated with the ticket.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ticketPriority": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "priorityLevel": "urgent" }, "ticketStatus": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "tab": "string", "color": "string" }, "insightId": "e0b109ff-077c-4d58-916e-b128cab16ecb", "summary": "string", "description": "string", "cause": "string", "solution": "string", "reporter": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "assigneeType": "noAssignee", "userAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "workgroupAssignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "creator": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "company": "string" }, "dueDate": "2019-08-24T14:15:22Z", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "startedDate": "2019-08-24T14:15:22Z", "resolvedDate": "2019-08-24T14:15:22Z", "closedDate": "2019-08-24T14:15:22Z", "sourceType": "Adx", "sourceName": "string", "externalId": "string", "externalCreatedDate": "2019-08-24T14:15:22Z", "externalUpdatedDate": "2019-08-24T14:15:22Z", "latitude": 0.1, "longitude": 0.1, "customProperties": { "property1": "string", "property2": "string" }, "extendableSearchablePropertyKeys": [ "string" ], "scheduledDate": "2019-08-24T14:15:22Z", "occurrence": 0, "locations": [ { … } ], "twin": { "id": "string", "name": "string", "modelId": "string" }, "recommendations": [ { … } ], "category": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "jobType": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "serviceNeeded": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "subStatus": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "comments": [ { … } ], "attachments": [ { … } ], "ticketCosts": [ { … } ] }
- https://{instance}.app.willowinc.com/api/v3/tickets/{ticketId}/attachments/{attachmentId}
- Payload
- JS
- C#
- Java
- Python
No request payload