| Requires any of the roles: | Admin, TenantAdmin, AccessTemplateAdmin |
| GET | /access/template/things | Get thing access templates |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccessTemplateId | query | string | Yes | Access templateId Id (GUID) |
| LoadChildThingAccessTemplates | query | boolean | No | Include child elements in the response |
| LoadThings | query | boolean | No | Include thing list in the response |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | List<ThingAccessTemplateView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| ThingId | form | Guid | No | |
| Thing | form | ThingView | No | |
| Permission | form | List<string> | No | |
| AvailableFrom | form | int? | No | |
| AvailableTo | form | int? | No | |
| AccessCount | form | int? | No | |
| Exclusive | form | bool | No | |
| AccessLevel | form | string | No | |
| ChildPermissionThingTemplates | form | List<ThingAccessTemplateView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | |
| DisplayTemplate | form | string | No | |
| Properties | form | Dictionary<string, Object> | No | |
| States | form | Dictionary<string, List<StateValueView>> | No | |
| TaskLists | form | List<TaskListView> | No | |
| ChildThings | form | List<ThingView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| OrganizationId | form | Guid | No | |
| Name | form | string | No | |
| Order | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| TaskListAssignee | form | TaskListAssigneeView | No | |
| AccessTemplateId | form | Guid? | No | |
| AccessTemplateName | form | string | No | |
| Priority | form | TaskListPriority | No | |
| Start | form | DateTime | No | |
| Deadline | form | DateTime? | No | |
| Created | form | DateTime | No | |
| Categories | form | IEnumerable<string> | No | |
| RecurrenceConfiguration | form | string | No | |
| Status | form | Status | No | |
| Name | form | string | No | |
| IncompleteReason | form | IncompleteReason? | No | |
| IncompleteReasonDescription | form | string | No | |
| Instructions | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| TeamId | form | Guid? | No | |
| Team | form | TeamBasicView | No | |
| ShiftId | form | Guid? | No | |
| Shift | form | ShiftView | No | |
| BusinessUser | form | BusinessUserBasicView | No | |
| BusinessUserId | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| OrganizationId | form | Guid | No | |
| Name | form | string | No | |
| TeamId | form | Guid? | No | |
| StartTimeOffset | form | int | No | |
| EndTimeOffset | form | int | No | |
| StartDate | form | DateTime? | No | |
| EndDate | form | DateTime? | No | |
| ShiftMembers | form | IReadOnlyCollection<ShiftMemberView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| BusinessUserId | form | int | No | |
| ShiftId | form | Guid | No | |
| BusinessUser | form | BusinessUserBasicView | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No |
| Name | Value |
|---|---|
| None | 0 |
| VeryLow | 10 |
| Low | 20 |
| Medium | 30 |
| High | 40 |
| VeryHigh | 50 |
| Critical | 60 |
| Name | Value |
|---|---|
| ToDo | 0 |
| InProgress | 10 |
| Incomplete | 30 |
| Done | 40 |
| Name | Value |
|---|---|
| ResourcesMissing | 10 |
| PrioritySwitch | 20 |
| GuestDeclined | 30 |
| FeelingUnwell | 40 |
| Other | 50 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /access/template/things HTTP/1.1 Host: api.4spaces.io Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'ThingAccessTemplatesResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)