1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-03-25 21:39:21 +02:00
Vitaly the Alpaca (bot) 5cc51552f4 Main build (Jenkins)
2024-11-21 22:39:27 +03:00

128 lines
3.0 KiB
Plaintext

---
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get deal
Gets deal by ID
`Function GetDeal(Val URL, Val DealID, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | ✔ | URL of webhook or a Bitrix24 domain, when token used |
| DealID | --deal | Number, String | ✔ | Deal ID |
| Token | --token | String | ✖ | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [crm.deal.get](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_get.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
DealID = "1656";
Result = OPI_Bitrix24.GetDeal(URL, DealID);
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
DealID = "1656";
Result = OPI_Bitrix24.GetDeal(URL, DealID, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 GetDeal \
--url "b24-ar17wx.bitrix24.by" \
--deal 1680 \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 GetDeal ^
--url "b24-ar17wx.bitrix24.by" ^
--deal 1680 ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": {
"ID": "772",
"TITLE": "Planned sale",
"TYPE_ID": "GOODS",
"STAGE_ID": "NEW",
"PROBABILITY": "30",
"CURRENCY_ID": "USD",
"OPPORTUNITY": "5000.00",
"IS_MANUAL_OPPORTUNITY": "N",
"TAX_VALUE": null,
"LEAD_ID": null,
"COMPANY_ID": "1",
"CONTACT_ID": "3",
"QUOTE_ID": null,
"BEGINDATE": "2024-01-01T03:00:00+03:00",
"CLOSEDATE": "2030-01-01T03:00:00+03:00",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-10-09T09:22:26+03:00",
"DATE_MODIFY": "2024-10-09T09:22:26+03:00",
"OPENED": "Y",
"CLOSED": "N",
"COMMENTS": null,
"ADDITIONAL_INFO": null,
"LOCATION_ID": null,
"CATEGORY_ID": "0",
"STAGE_SEMANTIC_ID": "P",
"IS_NEW": "Y",
"IS_RECURRING": "N",
"IS_RETURN_CUSTOMER": "N",
"IS_REPEATED_APPROACH": "N",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-10-09T09:22:26+03:00",
"LAST_ACTIVITY_TIME": "2024-10-09T09:22:26+03:00",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1"
},
"time": {
"start": 1728454947.12395,
"finish": 1728454947.17279,
"duration": 0.0488379001617432,
"processing": 0.0184519290924072,
"date_start": "2024-10-09T09:22:27+03:00",
"date_finish": "2024-10-09T09:22:27+03:00",
"operating_reset_at": 1728455547,
"operating": 0
}
}
```