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

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load.

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page.

filter[sim_card_group_id] uuid

A valid SIM card group ID.

filter[status] string

Possible values: [in-progress, completed, failed]

Filter by a specific status of the resource's lifecycle.

filter[type] string

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

data

object[]

Array [

id uuid

Identifies the resource.

record_type string

sim_card_group_id uuid

The SIM card group identification.

type string

Possible values: [set_private_wireless_gateway, remove_private_wireless_gateway]

Represents the type of the operation requested.

status string

Possible values: [in-progress, completed, failed]

settings

object

A JSON object representation of the action params.

private_wireless_gateway_id uuid

The identification of the related Private Wireless Gateway resource.

A JSON object representation of the action params.

created_at string

ISO 8601 formatted date-time indicating when the resource was created.

updated_at string

ISO 8601 formatted date-time indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...