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": "4998c318-961d-4e48-b33e-9aa8403034ca",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "2b4a5099-2560-49d7-8bfb-fed2cb01057c",
"Section": {
"TaskTypeSectionId": "21820f86-5e4a-445b-868e-a3e4e9d811f9",
"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": "d5c83434-f828-40af-9fac-f1188e1c545a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "437ec994-6150-4e16-a97c-02743fbc4c2d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9b065597-4d00-4183-995b-2f99b6e0eca6",
"CreateDate": "2024-12-08T12:57:14.4975215-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T12:57:14.4975215-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "2b4a5099-2560-49d7-8bfb-fed2cb01057c",
"Section": {
"TaskTypeSectionId": "21820f86-5e4a-445b-868e-a3e4e9d811f9",
"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": "d5c83434-f828-40af-9fac-f1188e1c545a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "437ec994-6150-4e16-a97c-02743fbc4c2d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9b065597-4d00-4183-995b-2f99b6e0eca6",
"CreateDate": "2024-12-08T12:57:14.4975215-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T12:57:14.4975215-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "344205ad-24d4-4f91-9f58-4d98223a8dbf",
"CreateDate": "2024-12-08T12:57:14.4975215-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T12:57:14.4975215-08:00",
"LastModifiedUser": "sample string 7"
},
{
"TaskTypeId": "4998c318-961d-4e48-b33e-9aa8403034ca",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "2b4a5099-2560-49d7-8bfb-fed2cb01057c",
"Section": {
"TaskTypeSectionId": "21820f86-5e4a-445b-868e-a3e4e9d811f9",
"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": "d5c83434-f828-40af-9fac-f1188e1c545a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "437ec994-6150-4e16-a97c-02743fbc4c2d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9b065597-4d00-4183-995b-2f99b6e0eca6",
"CreateDate": "2024-12-08T12:57:14.4975215-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T12:57:14.4975215-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "2b4a5099-2560-49d7-8bfb-fed2cb01057c",
"Section": {
"TaskTypeSectionId": "21820f86-5e4a-445b-868e-a3e4e9d811f9",
"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": "d5c83434-f828-40af-9fac-f1188e1c545a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "437ec994-6150-4e16-a97c-02743fbc4c2d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9b065597-4d00-4183-995b-2f99b6e0eca6",
"CreateDate": "2024-12-08T12:57:14.4975215-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T12:57:14.4975215-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0b767b1-db1d-4dbb-9a19-d2ae50104471",
"FieldId": "e1d487b6-b8f4-4669-9262-136063400bfb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "344205ad-24d4-4f91-9f58-4d98223a8dbf",
"CreateDate": "2024-12-08T12:57:14.4975215-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T12:57:14.4975215-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}