Skip to main content

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

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.

    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

default: Unexpected error

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
  • ]

Loading...