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": "6f6a12d0-8241-4b25-826f-51ae82f0a5f1",
"Name": "sample string 1",
"Description": "sample string 2",
"Fields": [
{
"TaskTypeFieldId": "81392927-094a-4a24-84f0-5f6124333345",
"Section": {
"TaskTypeSectionId": "2e6255e8-682c-4e7d-9c7c-61f83bfe86c3",
"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": "13f425e7-fa72-4c5e-9bfc-c9a5a3a11e64",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "25e75824-83ea-4023-a7ee-404197079633",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c60f2017-c38c-4eda-9602-4328c3bde3fb",
"CreateDate": "2023-09-22T12:23:02.0236614-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:23:02.0236614-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": "81392927-094a-4a24-84f0-5f6124333345",
"Section": {
"TaskTypeSectionId": "2e6255e8-682c-4e7d-9c7c-61f83bfe86c3",
"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": "13f425e7-fa72-4c5e-9bfc-c9a5a3a11e64",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "25e75824-83ea-4023-a7ee-404197079633",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c60f2017-c38c-4eda-9602-4328c3bde3fb",
"CreateDate": "2023-09-22T12:23:02.0236614-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:23:02.0236614-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 3",
"CompanyId": "62cfb8d7-624d-40c6-95f1-c9a47345be61",
"CreateDate": "2023-09-22T12:23:02.0236614-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:23:02.0236614-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TaskTypeId": "6f6a12d0-8241-4b25-826f-51ae82f0a5f1",
"Name": "sample string 1",
"Description": "sample string 2",
"Fields": [
{
"TaskTypeFieldId": "81392927-094a-4a24-84f0-5f6124333345",
"Section": {
"TaskTypeSectionId": "2e6255e8-682c-4e7d-9c7c-61f83bfe86c3",
"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": "13f425e7-fa72-4c5e-9bfc-c9a5a3a11e64",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "25e75824-83ea-4023-a7ee-404197079633",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c60f2017-c38c-4eda-9602-4328c3bde3fb",
"CreateDate": "2023-09-22T12:23:02.0236614-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:23:02.0236614-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": "81392927-094a-4a24-84f0-5f6124333345",
"Section": {
"TaskTypeSectionId": "2e6255e8-682c-4e7d-9c7c-61f83bfe86c3",
"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": "13f425e7-fa72-4c5e-9bfc-c9a5a3a11e64",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "25e75824-83ea-4023-a7ee-404197079633",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c60f2017-c38c-4eda-9602-4328c3bde3fb",
"CreateDate": "2023-09-22T12:23:02.0236614-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:23:02.0236614-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 3",
"CompanyId": "62cfb8d7-624d-40c6-95f1-c9a47345be61",
"CreateDate": "2023-09-22T12:23:02.0236614-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:23:02.0236614-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}