GET api/2.0/crm/opportunity/filter

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

Описание

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

Параметры

НазваниеописаниеТипПример
responsibleid

sent in url
Идентификатор ответственного за возможную сделку

необязательно
guid9924256A-739C-462b-AF15-E652A3B1B6EB
opportunityStagesid

sent in url
Идентификатор этапа возможной сделки

необязательно
номер1234
tags

sent in url
Теги возможной сделки

необязательно
Collection of strings

collection
some text
contactid

sent in url
Идентификатор контакта

необязательно
номер1234
contactAlsoIsParticipant

sent in url
Статус участия: учитывайте возможные сделки, где контакт является участником или нет

необязательно
логическийистина
fromDate

sent in url
Дата начала

необязательно
дата и времяRoundtrip format: 2008-04-10T06-30-00.000Z
toDate

sent in url
Дата оканчания

необязательно
дата и времяRoundtrip format: 2008-04-10T06-30-00.000Z
stageType

sent in url
Тип этапа возможной сделки
Допустимые значения: {Open, ClosedAndWon, ClosedAndLost}
необязательно
ASC.CRM.Core.DealMilestoneStatus
Пример
GET api/2.0/crm/opportunity/filter?responsibleid=9924256A-739C-462b-AF15-E652A3B1B6EB&opportunityStagesid=1234&tags=%5b%22some+text%22%5d&contactid=1234&fromDate=2008-04-10T06-30-00.000Z&toDate=2008-04-10T06-30-00.000Z
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

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

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

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.1944111Z",
      "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.1944111Z",
      "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.1944111Z</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.1944111Z</expectedCloseDate>
    <isPrivate>false</isPrivate>
    <canEdit>false</canEdit>
    <id>0</id>
  </response>
</result>