GET api/entityProperties

Метод для получения "Свойств"

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/entityProperties

  Для этого метода требуется авторизация

Информация о запросе

URL параметры

НазваниеОписаниеТип данныхДополнительная информация
Fields

Список дополнительных полей, которые необходимо вернуть

 string

Нет
Sort

Поле по которому необходима сортировка результатов

 string

Нет
Page

Номер страницы (начиная с 1)

 integer

Интервал: с 1 по 2147483646
PageSize

Кол-во записей на странице (макс. 50)

 integer

Интервал: с 1 по 50

Тело запроса

Нет параметров в теле запроса

Информация об ответе

PagedResponseModelOfEntityPropertyModel
НазваниеОписаниеТип данныхДополнительная информация
Data

Collection of EntityPropertyModel

Нет
Pagination

PaginationModel

Нет

Форматы ответа

{
  "data": [
    {
      "id": "239c0599-1f83-4bbc-abaf-9f79eb6b2b06",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "entityDataType": "string",
      "valueLookup": "contacts",
      "required": true
    },
    {
      "id": "239c0599-1f83-4bbc-abaf-9f79eb6b2b06",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "entityDataType": "string",
      "valueLookup": "contacts",
      "required": true
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 2,
    "totalCount": 3,
    "totalPages": 4,
    "prevPageLink": "sample string 5",
    "nextPageLink": "sample string 6"
  }
}

<PagedResponseModelOfEntityPropertyModeln689RkeX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Miscellaneous.Pagination">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties">
    <d2p1:EntityPropertyModel>
      <d2p1:EntityDataType>String</d2p1:EntityDataType>
      <d2p1:Id>239c0599-1f83-4bbc-abaf-9f79eb6b2b06</d2p1:Id>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:ValueLookup>Contacts</d2p1:ValueLookup>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:EntityPropertyModel>
    <d2p1:EntityPropertyModel>
      <d2p1:EntityDataType>String</d2p1:EntityDataType>
      <d2p1:Id>239c0599-1f83-4bbc-abaf-9f79eb6b2b06</d2p1:Id>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:ValueLookup>Contacts</d2p1:ValueLookup>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:EntityPropertyModel>
  </Data>
  <Pagination>
    <NextPageLink>sample string 6</NextPageLink>
    <Page>1</Page>
    <PageSize>2</PageSize>
    <PrevPageLink>sample string 5</PrevPageLink>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Pagination>
</PagedResponseModelOfEntityPropertyModeln689RkeX>