List SIM card group actions
GET/sim_card_group_actions
This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.
Request
Query Parameters
Possible values: >= 1
Default value: 1
The page number to load.
Possible values: >= 1
and <= 250
Default value: 20
The size of the page.
A valid SIM card group ID.
Possible values: [in-progress
, completed
, failed
]
Filter by a specific status of the resource's lifecycle.
Possible values: [set_private_wireless_gateway
, remove_private_wireless_gateway
]
Filter by action type.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
Identifies the resource.
The SIM card group identification.
Possible values: [set_private_wireless_gateway
, remove_private_wireless_gateway
]
Represents the type of the operation requested.
Possible values: [in-progress
, completed
, failed
]
settings
object
A JSON object representation of the action params.
The identification of the related Private Wireless Gateway resource.
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was updated.
meta
object
{
"data": [
{
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group_action",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"type": "set_private_wireless_gateway",
"status": "in-progress",
"settings": {
"private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
},
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}