Get a List of Applications

The method returns a List of Applications.


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

Arguments

Name

Parameter Type

Data type

Required/
Optional

Description

api_tokenquerystringRequiredAPI token of the manager who perform the operation (see API Token Authentication)

page

query

integer

Optional

Returning a list of Application instances by current page number

per_page

query

integer

Optional

Setting a number of items in the page

sorting[field]

query

string

Optional

Sorting the list by the specified field

sorting[reversed]

query

string

Optional

Set the reversed sorting mode by the specified field:

  • true — descending sorting.
  • false — ascending sorting (by default).

filters[created_at]

query

date

Optional

Filtering the list by a creation date

filters[updated_at]

query

date

Optional

Filtering the list by an update date

filters[service_status]

query

string

Optional

Filtering the list by a service status

filters[subscription_id]

query

integer

Optional

Filtering the list by a Subscription ID

filters[Application_template_id]

query

integer

Optional

Filtering the list by an Application template ID

Response model

Name

Data type

Description

id

integer

An ID of the Application instance

subscription_id

integer

A Subscription ID, which based on the Application instance

origin_id

integer

An Order number of the Application instance

origin_type

string

An internal type of the Application instance, which is used as a polymorphic association

service_status

string

A service status of the Application instance:

  • not_provisioned — provisioning of the Application instance was not completed.

  • provisioning — an Application instance is being provisioned.

  • provisioning_failed — an error during the provisioning process.

  • running — an Application instance is running.

  • renewing — an Application instance is renewing.

  • renewing_failed — an error during the renewing of the Application instance.

  • stopped — an Application instance was stopped.

Application_template_id

integer

An Application template ID, on which base the Application instance was created

created_at

date

A date and time of the Application instance's creation

updated_at

date

A date and time, when the Application instance was updated last time

Request example

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

Response example

[ 
 { 
   "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" 
  }
]