Viviot.Api

<back to all web services

UpdateTaskListTemplate

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
PUT/tasklist/templateUpdates a task list template.
UpdateTaskListTemplate Parameters:
NameParameterData TypeRequiredDescription
TaskListTemplateIdbodystringYesTasklist template ID
CommonTaskListTemplateApi Parameters:
NameParameterData TypeRequiredDescription
PriorityformTaskListPriorityYesTaskListPriority, ranking this tasklist template amid others.

Allowable Values

  • None
  • VeryLow
  • Low
  • Medium
  • High
  • VeryHigh
  • Critical
NameformstringYesThe list template's name.
CategoriesformarrayNoTags under which to categorize the tasklist.
AccessTemplateIdformstringNoAccess template ID.
InstructionsformstringNoInstructions on how to complete the task list.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskListPriority Enum:
NameValue
None0
VeryLow10
Low20
Medium30
High40
VeryHigh50
Critical60
Category Enum:
NameValue
Cleaning10
Maintenance20
Disinfection30
Inspection40
Security50
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /tasklist/template HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	taskListTemplateId: 00000000000000000000000000000000,
	priority: 0,
	name: String,
	categories: 
	[
		10
	],
	accessTemplateId: 00000000000000000000000000000000,
	instructions: String,
	version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}