2024-06-20 09:39:55 +02:00
|
|
|
---
|
2024-07-14 17:23:26 +02:00
|
|
|
sidebar_position: 26
|
2024-06-20 09:39:55 +02:00
|
|
|
---
|
|
|
|
|
|
|
|
# Get task fields structure
|
|
|
|
Gets a structure with a description of the fields for creating a task
|
|
|
|
|
|
|
|
|
2024-07-10 10:59:55 +02:00
|
|
|
|
2024-07-10 12:58:29 +02:00
|
|
|
`Function GetTaskFieldsStructure(Val URL, Val Token = "") Export`
|
2024-06-20 09:39:55 +02:00
|
|
|
|
|
|
|
| Parameter | CLI option | Type | Destination |
|
|
|
|
|-|-|-|-|
|
|
|
|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
2024-07-15 21:16:10 +02:00
|
|
|
| Token | --token | String | Access token, when app auth method used |
|
2024-06-20 09:39:55 +02:00
|
|
|
|
|
|
|
|
|
|
|
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
|
|
|
|
2024-07-10 13:05:58 +02:00
|
|
|
<br/>
|
2024-07-10 10:59:55 +02:00
|
|
|
|
2024-07-14 17:23:26 +02:00
|
|
|
:::tip
|
|
|
|
Method at API documentation: [tasks.task.getFields](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getFields.php)
|
|
|
|
:::
|
|
|
|
<br/>
|
2024-07-10 12:58:29 +02:00
|
|
|
|
|
|
|
|
2024-06-20 09:39:55 +02:00
|
|
|
```bsl title="Code example"
|
2024-07-10 13:24:11 +02:00
|
|
|
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
|
2024-06-20 09:39:55 +02:00
|
|
|
|
|
|
|
Result = OPI_Bitrix24.GetTaskFieldsStructure(URL);
|
|
|
|
|
|
|
|
|
|
|
|
URL = "b24-ar17wx.bitrix24.by";
|
2024-07-14 18:04:01 +02:00
|
|
|
Token = "adf89366006e9f06006b12e400000001000...";
|
2024-06-20 09:39:55 +02:00
|
|
|
|
|
|
|
Result = OPI_Bitrix24.GetTaskFieldsStructure(URL, Token);
|
|
|
|
```
|
2024-07-10 10:59:55 +02:00
|
|
|
|
|
|
|
|
2024-06-20 09:39:55 +02:00
|
|
|
|
|
|
|
```sh title="CLI command example"
|
|
|
|
|
2024-06-21 08:25:14 +02:00
|
|
|
oint bitrix24 GetTaskFieldsStructure --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
|
2024-06-20 09:39:55 +02:00
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
```json title="Result"
|
2024-07-10 13:11:17 +02:00
|
|
|
{
|
2024-06-20 09:39:55 +02:00
|
|
|
"result": {
|
|
|
|
"fields": {
|
|
|
|
"ID": {
|
|
|
|
"title": "ID",
|
|
|
|
"type": "integer",
|
|
|
|
"primary": true
|
|
|
|
},
|
|
|
|
"PARENT_ID": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "ID of base task",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer",
|
|
|
|
"default": 0
|
|
|
|
},
|
|
|
|
"TITLE": {
|
|
|
|
"title": "Name",
|
|
|
|
"type": "string",
|
|
|
|
"required": true
|
|
|
|
},
|
|
|
|
"DESCRIPTION": {
|
|
|
|
"title": "Description",
|
|
|
|
"type": "string"
|
|
|
|
},
|
|
|
|
"MARK": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Mark",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"N": "Negative",
|
|
|
|
"P": "Positive"
|
2024-06-20 09:39:55 +02:00
|
|
|
},
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"PRIORITY": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Priority",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"2": "High",
|
|
|
|
"1": "Normal",
|
|
|
|
"0": "Low"
|
2024-06-20 09:39:55 +02:00
|
|
|
},
|
|
|
|
"default": 1
|
|
|
|
},
|
|
|
|
"STATUS": {
|
|
|
|
"title": "Status",
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"2": "Waiting of completing",
|
|
|
|
"3": "In work",
|
|
|
|
"4": "On controll",
|
|
|
|
"5": "Complete",
|
|
|
|
"6": "Deferred"
|
2024-06-20 09:39:55 +02:00
|
|
|
},
|
|
|
|
"default": 2
|
|
|
|
},
|
|
|
|
"MULTITASK": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Multiple task",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"NOT_VIEWED": {
|
|
|
|
"title": null,
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"REPLICATE": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Repeatable task",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"GROUP_ID": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Project",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer",
|
|
|
|
"default": 0
|
|
|
|
},
|
|
|
|
"STAGE_ID": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Stage",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer",
|
|
|
|
"default": 0
|
|
|
|
},
|
|
|
|
"CREATED_BY": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Producer",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer",
|
|
|
|
"required": true
|
|
|
|
},
|
|
|
|
"CREATED_DATE": {
|
|
|
|
"title": null,
|
|
|
|
"type": "datetime"
|
|
|
|
},
|
|
|
|
"RESPONSIBLE_ID": {
|
|
|
|
"title": "Responsible",
|
|
|
|
"type": "integer",
|
|
|
|
"required": true
|
|
|
|
},
|
|
|
|
"ACCOMPLICES": {
|
|
|
|
"title": null,
|
|
|
|
"type": "array"
|
|
|
|
},
|
|
|
|
"AUDITORS": {
|
|
|
|
"title": null,
|
|
|
|
"type": "array"
|
|
|
|
},
|
|
|
|
"CHANGED_BY": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Changer",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"CHANGED_DATE": {
|
|
|
|
"title": "Date change",
|
|
|
|
"type": "datetime"
|
|
|
|
},
|
|
|
|
"STATUS_CHANGED_BY": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Changer status",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"STATUS_CHANGED_DATE": {
|
|
|
|
"title": "Date change of status",
|
|
|
|
"type": "datetime"
|
|
|
|
},
|
|
|
|
"CLOSED_BY": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Close task",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"CLOSED_DATE": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Date of closing",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "datetime",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"ACTIVITY_DATE": {
|
|
|
|
"title": null,
|
|
|
|
"type": "datetime",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"DATE_START": {
|
|
|
|
"title": "Date of start",
|
|
|
|
"type": "datetime",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"DEADLINE": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Last deadline",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "datetime",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"START_DATE_PLAN": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Planned start",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "datetime",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"END_DATE_PLAN": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Planned end",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "datetime",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"GUID": {
|
|
|
|
"title": "GUID",
|
|
|
|
"type": "string",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"XML_ID": {
|
|
|
|
"title": "XML_ID",
|
|
|
|
"type": "string",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"COMMENTS_COUNT": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Comments count",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer",
|
|
|
|
"default": 0
|
|
|
|
},
|
|
|
|
"SERVICE_COMMENTS_COUNT": {
|
|
|
|
"title": null,
|
|
|
|
"type": "integer",
|
|
|
|
"default": 0
|
|
|
|
},
|
|
|
|
"NEW_COMMENTS_COUNT": {
|
|
|
|
"title": null,
|
|
|
|
"type": "integer",
|
|
|
|
"default": 0
|
|
|
|
},
|
|
|
|
"ALLOW_CHANGE_DEADLINE": {
|
|
|
|
"title": null,
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"ALLOW_TIME_TRACKING": {
|
|
|
|
"title": null,
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"TASK_CONTROL": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Approve task",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"ADD_IN_REPORT": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Add in report",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"FORKED_BY_TEMPLATE_ID": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Created from template",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"TIME_ESTIMATE": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Time spend",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"TIME_SPENT_IN_LOGS": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Time spend from changes history",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"MATCH_WORK_TIME": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Skip weekends",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"FORUM_TOPIC_ID": {
|
|
|
|
"title": "FORUM_TOPIC_ID",
|
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"FORUM_ID": {
|
|
|
|
"title": "FORUM_ID",
|
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"SITE_ID": {
|
|
|
|
"title": "SITE_ID",
|
|
|
|
"type": "string"
|
|
|
|
},
|
|
|
|
"SUBORDINATE": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Task of dependent",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"FAVORITE": {
|
|
|
|
"title": null,
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"EXCHANGE_MODIFIED": {
|
|
|
|
"title": "EXCHANGE_MODIFIED",
|
|
|
|
"type": "datetime",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"EXCHANGE_ID": {
|
|
|
|
"title": "EXCHANGE_ID",
|
|
|
|
"type": "integer",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"OUTLOOK_VERSION": {
|
|
|
|
"title": "OUTLOOK_VERSION",
|
|
|
|
"type": "integer",
|
|
|
|
"default": null
|
|
|
|
},
|
|
|
|
"VIEWED_DATE": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Date of last view",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "datetime"
|
|
|
|
},
|
|
|
|
"SORTING": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Index of sorting",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "double"
|
|
|
|
},
|
|
|
|
"DURATION_PLAN": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Spend (plan)",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"DURATION_FACT": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"title": "Spend (fact)",
|
2024-06-20 09:39:55 +02:00
|
|
|
"type": "integer"
|
|
|
|
},
|
|
|
|
"CHECKLIST": {
|
|
|
|
"title": null,
|
|
|
|
"type": "array"
|
|
|
|
},
|
|
|
|
"DURATION_TYPE": {
|
|
|
|
"title": "DURATION_TYPE",
|
|
|
|
"type": "enum",
|
|
|
|
"values": [
|
|
|
|
"secs",
|
|
|
|
"mins",
|
|
|
|
"hours",
|
|
|
|
"days",
|
|
|
|
"weeks",
|
|
|
|
"monts",
|
|
|
|
"years"
|
|
|
|
],
|
|
|
|
"default": "days"
|
|
|
|
},
|
|
|
|
"IS_MUTED": {
|
|
|
|
"title": null,
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"IS_PINNED": {
|
|
|
|
"title": null,
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"IS_PINNED_IN_GROUP": {
|
|
|
|
"title": null,
|
|
|
|
"type": "enum",
|
|
|
|
"values": {
|
2024-06-21 08:25:14 +02:00
|
|
|
"Y": "Yes",
|
2024-06-20 09:39:55 +02:00
|
|
|
"N": "No"
|
|
|
|
},
|
|
|
|
"default": "N"
|
|
|
|
},
|
|
|
|
"FLOW_ID": {
|
|
|
|
"title": null,
|
|
|
|
"type": "integer",
|
|
|
|
"default": 0
|
|
|
|
},
|
|
|
|
"UF_CRM_TASK": {
|
|
|
|
"title": "Items CRM",
|
|
|
|
"type": "crm"
|
|
|
|
},
|
|
|
|
"UF_TASK_WEBDAV_FILES": {
|
|
|
|
"title": "Load files",
|
|
|
|
"type": "disk_file"
|
|
|
|
},
|
|
|
|
"UF_MAIL_MESSAGE": {
|
|
|
|
"title": null,
|
|
|
|
"type": "mail_message"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"time": {
|
|
|
|
"start": 1718473322.5296,
|
|
|
|
"finish": 1718473322.56673,
|
|
|
|
"duration": 0.0371248722076416,
|
|
|
|
"processing": 0.00164389610290527,
|
|
|
|
"date_start": "2024-06-15T17:42:02+00:00",
|
|
|
|
"date_finish": "2024-06-15T17:42:02+00:00",
|
|
|
|
"operating_reset_at": 1718473922,
|
|
|
|
"operating": 0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|