GET TaskTypes?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves task types for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| take |
Number of task types to retrieve. Default is all task types |
integer |
None. |
| skip |
Number of task types to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the task types before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of task types.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of TaskType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"TaskTypeId": "4183fa86-7287-4ca9-9565-69c4b4120216",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "2c1d269f-043d-477c-bada-6ffeac087b61",
"Section": {
"TaskTypeSectionId": "22da3cd4-5cc9-446a-b707-8e20648940d0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "703a56ec-e7f3-4940-8b07-3fa55a54eb01",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "361e50de-9caa-4719-811e-97b65bdb769a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "49864dfc-c66b-4e12-acba-7f5c76b63316",
"CreateDate": "2025-03-18T16:43:17.9784313-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:43:17.9784313-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
},
{
"TaskTypeFieldId": "2c1d269f-043d-477c-bada-6ffeac087b61",
"Section": {
"TaskTypeSectionId": "22da3cd4-5cc9-446a-b707-8e20648940d0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "703a56ec-e7f3-4940-8b07-3fa55a54eb01",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "361e50de-9caa-4719-811e-97b65bdb769a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "49864dfc-c66b-4e12-acba-7f5c76b63316",
"CreateDate": "2025-03-18T16:43:17.9784313-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:43:17.9784313-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "8986a412-370b-485e-9c1b-13004c52997c",
"CreateDate": "2025-03-18T16:43:17.9784313-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T16:43:17.9784313-07:00",
"LastModifiedUser": "sample string 7"
},
{
"TaskTypeId": "4183fa86-7287-4ca9-9565-69c4b4120216",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "2c1d269f-043d-477c-bada-6ffeac087b61",
"Section": {
"TaskTypeSectionId": "22da3cd4-5cc9-446a-b707-8e20648940d0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "703a56ec-e7f3-4940-8b07-3fa55a54eb01",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "361e50de-9caa-4719-811e-97b65bdb769a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "49864dfc-c66b-4e12-acba-7f5c76b63316",
"CreateDate": "2025-03-18T16:43:17.9784313-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:43:17.9784313-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
},
{
"TaskTypeFieldId": "2c1d269f-043d-477c-bada-6ffeac087b61",
"Section": {
"TaskTypeSectionId": "22da3cd4-5cc9-446a-b707-8e20648940d0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "703a56ec-e7f3-4940-8b07-3fa55a54eb01",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "361e50de-9caa-4719-811e-97b65bdb769a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "49864dfc-c66b-4e12-acba-7f5c76b63316",
"CreateDate": "2025-03-18T16:43:17.9784313-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:43:17.9784313-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "8986a412-370b-485e-9c1b-13004c52997c",
"CreateDate": "2025-03-18T16:43:17.9784313-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T16:43:17.9784313-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}