Получение Списка экземпляров услуг

Метод Get List of Applications позволяет получить список всех Экземпляров услуг.

 GET /api/vendor/v1/applications.json?api_token={api_token}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/
Опциональный

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

page

query

integer

Опциональный

Возвращается список экземпляров услуг по указанному номеру страницы

per_page

query

integer

Опциональный

Установка числа элементов на странице

sorting[field]

query

string

Опциональный

Сортировка списка по указанному полю

sorting[reversed]

query

string

Опциональный

Установка режима обратной сортировки по указанному полю:

  • true — список будет отсортирован по убыванию.
  • false — список будет отсортирован по возрастанию (используется по умолчанию).

filters[created_at]

query

date

Опциональный

Фильтрация списка по дате создания

filters[updated_at]

query

date

Опциональный

Фильтрация списка по дате обновления

filters[service_status]

query

string

Опциональный

Фильтрация списка по параметру "service_status"

filters[subscription_id]

query

integer

Опциональный

Фильтрация списка по параметру "subscription_id"

filters[application_template_id]

query

integer

Опциональный

Фильтрация списка по параметру "application_template_id"

Модель ответа

Название

Тип данных

Описание

id

integer

ID Экземпляра услуги

subscription_id

integer

ID подписки, которая использует данный Экземпляр услуги

origin_id

integer

Порядковый номер Экземпляра услуги

origin_type

string

Внутренний тип Экземпляра услуги, используемый как полиморфная связь

service_status

string

Сервисный статус Экземпляра услуги:

  • not_provisioned — провижининг Экземпляра услуги не был осуществлен.

  • provisioning — экземпляр услуги в процессе провижининга.

  • provisioning_failed — в процессе провижининга возникла ошибка.

  • running — экземпляр услуги запущено.

  • renewing — происходит продление использования Экземпляра услуги.

  • renewing_failed — произошла ошибка в процессе продления использования Экземпляра услуг.

  • stopped — использование Экземпляра услуги было остановлено.

application_template_id

integer

ID услуги, на основе которого созданный данный Экземпляр услуги

created_at

date

Дата и время создания Экземпляра услуг

updated_at

date

Дата и время последнего изменения Экземпляра услуг

Пример запроса

GET http://billing.activeplatform.com:80/api/vendor/v1/applications.json?api_token=654321

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

[ 
 { 
   "id": 2000148, 
   "subscription_id": 2000176, 
   "origin_id": 14, 
   "origin_type": "Aps::Application", 
   "service_status": "running", 
   "application_template_id": 15, 
   "created_at": "2014-12-02T12:26:01.632+03:00", 
   "updated_at": "2014-12-02T12:26:04.895+03:00" 
  }, 
  { 
   "id": 2000149, 
   "subscription_id": 2000177, 
   "origin_id": 15, 
   "origin_type": "Aps::Application", 
   "service_status": "renewing", 
   "application_template_id": 14, 
   "created_at": "2014-12-02T13:01:19.895+03:00", 
   "updated_at": "2014-12-03T11:57:09.606+03:00" 
  }
]