Запись опубликована:09.10.2022
Post category:Возможные сделки
Запись изменена:03.11.2022

PUT api/2.0/crm/opportunity/filter/access

Для этой функции требуется аутентификация.

Описание
Задает права доступа к списку всех возможных сделок, соответствующих указанным в запросе параметрам.

Параметры

Название	Описание	Тип	Пример
responsibleid sent in body	Идентификатор ответственного за возможную сделку необязательно	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
opportunityStagesid sent in body	Идентификатор этапа возможной сделки необязательно	номер	1234
tags sent in body	Теги возможных сделок необязательно	Collection of strings collection	текст
contactid sent in body	Идентификатор контакта необязательно	номер	1234
contactAlsoIsParticipant sent in body	Статус участия: учитывайте возможные сделки, где контакт является участником или нет необязательно	логический	истина
fromDate sent in body	Дата начала необязательно	дата и время	Roundtrip format: 2008-04-10T06-30-00.000Z
toDate sent in body	Дата окончания необязательно	дата и время	Roundtrip format: 2008-04-10T06-30-00.000Z
stageType sent in body	Тип этапа возможной сделки Допустимые значения: {Open, ClosedAndWon, ClosedAndLost} optional	ASC.CRM.Core.DealMilestoneStatus
isPrivate sent in body	Конфиденциальность возможной сделки: частная или нет	логический	истина
accessList sent in body	Список пользователей с правами доступа	Collection of guids collection	9924256A-739C-462b-AF15-E652A3B1B6EB

Пример

PUT api/2.0/crm/opportunity/filter/access
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

{
  "responsibleid": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "opportunityStagesid": 1234,
  "tags": [
    "some text"
  ],
  "contactid": 1234,
  "contactAlsoIsParticipant": null,
  "fromDate": "2008-04-10T06-30-00.000Z",
  "toDate": "2008-04-10T06-30-00.000Z",
  "stageType": null,
  "isPrivate": true,
  "accessList": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Возвращает
Список возможных сделок

Пример ответа

application/json

{
  "status": 0,
  "response": [
    {
      "createBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2022-10-08T15:03:33.1787887Z",
      "contact": {
        "smallFotoUrl": "url to foto",
        "displayName": "Tadjeddine Bachir",
        "isCompany": false,
        "isPrivate": true,
        "isShared": false,
        "shareType": 0,
        "currency": null,
        "canEdit": false,
        "canDelete": false,
        "id": 0
      },
      "title": "Hotel catalogue",
      "description": "",
      "responsible": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "stage": {
        "successProbability": 20,
        "stageType": 0,
        "title": "Discussion",
        "description": "The potential buyer showed his\/her interest and sees how your offering meets his\/her goal",
        "color": "#B9AFD3",
        "sortOrder": 2,
        "id": 30
      },
      "successProbability": 65,
      "expectedCloseDate": "2022-10-08T15:03:33.1787887Z",
      "isPrivate": false,
      "canEdit": false,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <created>2022-10-08T15:03:33.1787887Z</created>
    <contact>
      <smallFotoUrl>url to foto</smallFotoUrl>
      <displayName>Tadjeddine Bachir</displayName>
      <isCompany>false</isCompany>
      <isPrivate>true</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </contact>
    <title>Hotel catalogue</title>
    <description></description>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <stage>
      <successProbability>20</successProbability>
      <stageType>0</stageType>
      <title>Discussion</title>
      <description>The potential buyer showed his/her interest and sees how your offering meets his/her goal</description>
      <color>#B9AFD3</color>
      <sortOrder>2</sortOrder>
      <id>30</id>
    </stage>
    <successProbability>65</successProbability>
    <expectedCloseDate>2022-10-08T15:03:33.1787887Z</expectedCloseDate>
    <isPrivate>false</isPrivate>
    <canEdit>false</canEdit>
    <id>0</id>
  </response>
</result>