Viviot.Api

<back to all web services

GetTaskListTemplate

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
GET/tasklist/templateGets a task list template in the current user's organization.
CommonBaseTaskListTemplate Parameters:
NameParameterData TypeRequiredDescription
TaskListTemplateIdformstringYesTasklist template ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskListTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
DataformTaskListTemplateViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TaskListTemplateView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
PriorityformTaskListPriorityNo
IsDeletedformboolNo
NameformstringNo
CategoriesformIEnumerable<string>No
AccessTemplateIdformGuid?No
InstructionsformstringNo
TaskListPriority Enum:
NameValue
None0
VeryLow10
Low20
Medium30
High40
VeryHigh50
Critical60

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.

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

{
	data: 
	{
		id: 00000000000000000000000000000000,
		organizationId: 00000000000000000000000000000000,
		priority: 0,
		isDeleted: False,
		name: String,
		accessTemplateId: 00000000000000000000000000000000,
		instructions: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}