MSP Services

PATCH /adminDelegations

Request:

• Changed content type : application/json

• Changed property associations (object)

  Set of MSP administrator associations to create or modify for customer accounts.

• Changed content type : application/vnd.ruckus.v1+json

• Changed property associations (object)

  Set of MSP administrator associations to create or modify for customer accounts.

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

    • Property args (object)

      Additional arguments or context related to the error.

    • Property code (object)

      Error code identifying the type of error.

    • Property message (object)

      Proper readable error message for understanding.

    • Property reason (object)

      Detailed explanation of why the error occurred.

    • Property suggestion (object)

      Suggested action to resolve the error.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PATCH /mspCustomers/delegations

Add Designated Tenant Accounts

Request:

• Changed content type : application/json

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PATCH /mspCustomers/mspAdmins/associations

Assign Administrators

Request:

• Changed content type : application/json

• Changed property associations (object)

  Set of MSP administrator associations to create or modify for customer accounts.

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers/{customerId}/activationStatus

Get Tenant Activation Status

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  • Changed property createdDate (object)

    Timestamp when the entity was created.

  • Changed property parentId (object)

    Identifier of the parent entity in the hierarchy.

  • Changed property properties (object)

    Additional custom properties stored as key value pairs for the MSP customer account.

  • Changed property switchActivated (object)

    Indicates whether switch services are activated for this MSP customer account.

  • Changed property tenantActivated (object)

    Indicates whether the tenant service is activated for this MSP customer account.

  • Changed property updatedDate (object)

    Timestamp when the entity was last updated.

  • Changed property wifiActivated (object)

    Indicates whether WiFi services are activated for this MSP customer account.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers/{customerId}/admins

List Tenant Administrators

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers/{customerId}/admins/{adminId}

Get Administrator Details

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /mspCustomers/{customerId}/admins/{adminId}

Assign Administrator

Request:

• Changed content type : application/json

Return Type:

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

DELETE /mspCustomers/{customerId}/admins/{adminId}

Remove Administrator

Return Type:

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers/{customerId}/delegations

Get Support Access Status

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

POST /mspCustomers/{customerId}/delegations

Enable Support Access

Return Type:

• Changed response : 201 Created

Created

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

DELETE /mspCustomers/{customerId}/delegations

Disable Support Access

Return Type:

• Changed response : 204 No Content

No Content

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /mspCustomers/{customerId}/delegatorAdmins

Update Admin Delegations

Request:

• Changed content type : application/json

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

POST /mspCustomers/{customerId}/invitations

Send Administrator Invitation

Request:

• Changed content type : application/json

• Changed property resend (object)

  Indicate if this is to resend in case of email got lost.

Return Type:

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers/{customerId}/logoUrls

Retrieve Brand Logo URLs

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers/{customerId}/mspadmins

Retrieve Admin Delegations

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /mspCustomers/{customerId}/mspadmins

Update Admin Delegations

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspIntegrators/{integratorId}

Retrieve Tenant Delegations

Parameters:

• Changed: integratorId in path

MSP-EC Delegated Id

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  • Changed property delegated_to (object)

    Tenant ID to which delegated.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PATCH /mspIntegrators/{integratorId}

Update Tenant Delegations

Parameters:

• Changed: integratorId in path

MSP-EC Delegated Id

Request:

• Changed content type : application/json

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspLabels/baseUrls

Retrieve Brand Base URLs

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspLabels/{mspLabel}

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /tenantActivations/supportStatus/{tenantId}

Get Support Access Status

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /tenantActivations/supportStatus/{tenantId}

Enable Support Access

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

DELETE /tenantActivations/supportStatus/{tenantId}

Disable Support Access

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /tenantActivations/{tenantId}

Reactivate Tenant

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

DELETE /tenantActivations/{tenantId}

Deactivate Tenant

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PATCH /tenantDelegations

Add Designated Tenant Accounts

Request:

• Changed content type : application/json

• Changed content type : application/vnd.ruckus.v1+json

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

POST /tenants

Create Managed Tenant

Request:

• Changed content type : application/json

• Changed content type : application/vnd.ruckus.v1+json

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

• Changed content type : application/vnd.ruckus.v1+json

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /tenants/{tenantId}/adminDelegations

Retrieve Admin Delegations

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /tenants/{tenantId}/adminDelegations

Update Admin Delegations

Request:

• Changed content type : application/json

• Changed content type : application/vnd.ruckus.v1+json

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /tenants/{tenantId}/admins

List Tenant Administrators

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /tenants/{tenantId}/admins/{adminId}

Get Administrator Details

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

• Changed content type : application/vnd.ruckus.v1+json

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /tenants/{tenantId}/admins/{adminId}

Request:

• Changed content type : application/json

Return Type:

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

DELETE /tenants/{tenantId}/admins/{adminId}

Remove Administrator

Return Type:

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /tenants/{tenantId}/invitations

Send Administrator Invitation

Request:

• Changed content type : application/json

• Changed property resend (object)

  Indicate if this is to resend in case of email got lost.

Return Type:

• Changed response : 204 No Content

No Content

• New content type : application/vnd.ruckus.v1+json

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /tenants/{tenantId}/tenantDelegations

Retrieve Tenant Delegations

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  • Changed property delegated_to (object)

    Tenant ID to which delegated.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property delegated_to (object)

    Tenant ID to which delegated.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /tenants/{tenantId}/tenantDelegations

Update Tenant Delegations

Request:

• Changed content type : application/json

• Changed content type : application/vnd.ruckus.v1+json

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers

List Managed Tenants

Return Type:

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

POST /mspCustomers

Create Managed Tenant

Request:

• Changed content type : application/json

• Changed property postal_code (object)

  The MSP-EC mailing address' postal code.

• Changed property street_address (object)

  The MSP-EC mailing address' street name and number.

• Changed property tier (object)

  Service tier information for MSP-EC.

• Changed property licenses (object)

  License configuration for managing trial licenses and license assignments for MSP accounts.

  • Changed property assignments (object)

    List of license assignments for account.

  • Changed property subscription_end_date (object)

    License subscription end date.

  • Changed property subscription_start_date (object)

    License subscription start date.

• Changed content type : application/vnd.ruckus.v1.2+json

• Changed property postal_code (object)

  The MSP-EC mailing address' postal code.

• Changed property street_address (object)

  The MSP-EC mailing address' street name and number.

• Changed property tier (object)

  Service tier information for MSP-EC.

• Changed property licenses (object)

  License configuration for managing trial licenses and license assignments for MSP accounts.

  • Changed property assignments (object)

    List of license assignments for account.

  • Changed property subscription_end_date (object)

    License subscription end date.

  • Changed property subscription_start_date (object)

    License subscription start date.

• Changed content type : application/vnd.ruckus.v1+json

• Changed property postal_code (object)

  The MSP-EC mailing address' postal code.

• Changed property street_address (object)

  The MSP-EC mailing address' street name and number.

• Changed property licenses (object)

  License configuration for managing trial licenses and license assignments for MSP accounts.

  • Changed property assignments (object)

    List of license assignments for account.

  • Changed property subscription_end_date (object)

    License subscription end date.

  • Changed property subscription_start_date (object)

    License subscription start date.

• Changed content type : application/vnd.ruckus.v1.1+json

• Changed property postal_code (object)

  The MSP-EC mailing address' postal code.

• Changed property street_address (object)

  The MSP-EC mailing address' street name and number.

• Changed property licenses (object)

  License configuration for managing trial licenses and license assignments for MSP accounts.

  • Changed property assignments (object)

    List of license assignments for account.

  • Changed property subscription_end_date (object)

    License subscription end date.

  • Changed property subscription_start_date (object)

    License subscription start date.

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1.1+json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1.2+json

  New required properties:

  • requestId

  • Added property requestId (object)

    Unique identifier for tracking the API request.

  • Added property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1.1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1.2+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1.1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1.2+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /mspCustomers/{customerId}

Retrieve Managed Tenant

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  • Changed property is_active (object)

    Active state of MSP-EC account.

  • Changed property logo_url (object)

    URL to access the MSP customer account's logo file.

  • Changed property msp_label (object)

    Label identifying the parent MSP.

  • Changed property postal_code (object)

    The postal code of MSP-EC account.

  • Changed property privacyFeatures (object)

    Privacy features for the account.

  • Changed property street_address (object)

    The street address of MSP-EC account.

  • Changed property tier (object)

    Service tier of the account.

• Changed response : 401 Unauthorized

Un Authorized

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 403 Forbidden

Forbidden

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

DELETE /mspCustomers/{customerId}

Remove Managed Tenant

Return Type:

• Changed response : 202 Accepted

Ok

• Changed content type : application/json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /mspCustomers/{customerId}

Update Managed Tenant

Request:

• Changed content type : application/json

• Changed property postal_code (object)

  The postal code of the MSP-EC account.

• Changed property privacyFeatures (object)

  Privacy features for the account.

• Changed property street_address (object)

  The street address of the MSP-EC account.

• Changed property tier (object)

  Service tier information for MSP-EC.

• Changed property licenses (object)

  License configuration for managing trial licenses and license assignments for MSP accounts.

  • Changed property assignments (object)

    List of license assignments for account.

  • Changed property subscription_end_date (object)

    License subscription end date.

  • Changed property subscription_start_date (object)

    License subscription start date.

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 403 Forbidden

Forbidden

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

GET /tenants/{tenantId}

Return Type:

• Changed response : 200 OK

Ok

• Changed content type : application/json

  • Changed property is_active (object)

    Active state of MSP-EC account.

  • Changed property logo_url (object)

    URL to access the MSP customer account's logo file.

  • Changed property msp_label (object)

    Label identifying the parent MSP.

  • Changed property postal_code (object)

    The postal code of MSP-EC account.

  • Changed property privacyFeatures (object)

    Privacy features for the account.

  • Changed property street_address (object)

    The street address of MSP-EC account.

  • Changed property tier (object)

    Service tier of the account.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property is_active (object)

    Active state of MSP-EC account.

  • Changed property logo_url (object)

    URL to access the MSP customer account's logo file.

  • Changed property msp_label (object)

    Label identifying the parent MSP.

  • Changed property postal_code (object)

    The postal code of MSP-EC account.

  • Changed property privacyFeatures (object)

    Privacy features for the account.

  • Changed property street_address (object)

    The street address of MSP-EC account.

  • Changed property tier (object)

    Service tier of the account.

• Changed response : 404 Not Found

Not Found

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

DELETE /tenants/{tenantId}

Return Type:

• Changed response : 202 Accepted

Ok

• Changed content type : application/json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

PUT /tenants/{tenantId}

Request:

• Changed content type : application/json

• Changed property postal_code (object)

  The postal code of the MSP-EC account.

• Changed property privacyFeatures (object)

  Privacy features for the account.

• Changed property street_address (object)

  The street address of the MSP-EC account.

• Changed property tier (object)

  Service tier information for MSP-EC.

• Changed property licenses (object)

  License configuration for managing trial licenses and license assignments for MSP accounts.

  • Changed property assignments (object)

    List of license assignments for account.

  • Changed property subscription_end_date (object)

    License subscription end date.

  • Changed property subscription_start_date (object)

    License subscription start date.

• Changed content type : application/vnd.ruckus.v1+json

• Changed property postal_code (object)

  The postal code of the MSP-EC account.

• Changed property privacyFeatures (object)

  Privacy features for the account.

• Changed property street_address (object)

  The street address of the MSP-EC account.

• Changed property tier (object)

  Service tier information for MSP-EC.

• Changed property licenses (object)

  License configuration for managing trial licenses and license assignments for MSP accounts.

  • Changed property assignments (object)

    List of license assignments for account.

  • Changed property subscription_end_date (object)

    License subscription end date.

  • Changed property subscription_start_date (object)

    License subscription start date.

Return Type:

• Changed response : 202 Accepted

Accepted

• Changed content type : application/json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property requestId (object)

    Unique identifier for tracking the API request.

  • Changed property tenantId (object)

    Tenant identifier associated with the request.

• Changed response : 400 Bad Request

Bad Request

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 403 Forbidden

Forbidden

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed response : 500 Internal Server Error

Server Error

• Changed content type : application/json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

• Changed content type : application/vnd.ruckus.v1+json

  • Added property error (object)

    Detailed error information including error code, message, reason, and suggested resolution.

  • Added property requestId (object)

    Unique identifier for the request that resulted in this error.

  • Deleted property errors (object)

POST /delegations

Request:

• Changed content type : application/json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

• Changed content type : application/vnd.ruckus.v1+json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

Return Type:

• Deleted response : 401 Unauthorized

Unauthorized

• Deleted response : 403 Forbidden

Forbidden

• Deleted response : 422 Unprocessable Entity

Validation error

• Deleted response : 500 Internal Server Error

Internal Server Error

• Deleted response : 501 Not Implemented

not implemented

• Changed response : 400 Bad Request

Bad request.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 404 Not Found

Requested resource or related entity not found.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 200 OK

Successful operation.

• Changed content type : application/json

  • Changed property alarmCount (object)

    The total number of active alarms.

  • Changed property crtTime (object)

    The creation timestamp in UTC milliseconds.

  • Changed property delegatedToEmail (object)

    The email address of the delegated administrator.

  • Changed property delegatedToName (object)

    The name of the delegated administrator.

  • Changed property delegationType (object)

    The type of delegation relationship.

  • Changed property earlyExpirationDate (object)

    The early expiration date for the delegation.

  • Changed property entitlements (object)

    The list of license entitlements for the delegation.

  • Changed property id (object)

    The unique identifier of the delegation.

  • Changed property status (object)

    The current status of the delegation.

  • Changed property switchLicenses (object)

    The total number of switch licenses.

  • Changed property tenantEmail (object)

    The email address of the tenant account.

  • Changed property tenantId (object)

    The unique identifier of the tenant account.

  • Changed property tenantName (object)

    The name of the tenant account.

  • Changed property type (object)

    The account type of the delegation.

  • Changed property wifiLicenses (object)

    The total number of WiFi licenses.

  • Changed property priorityIncidents (object)

    Count of support incidents categorized by priority level.

    • Changed property p1 (object)

      Number of priority 1 (critical) incidents.

    • Changed property p2 (object)

      Number of priority 2 (high) incidents.

    • Changed property p3 (object)

      Number of priority 3 (medium) incidents.

    • Changed property p4 (object)

      Number of priority 4 (low) incidents.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property alarmCount (object)

    The total number of active alarms.

  • Changed property crtTime (object)

    The creation timestamp in UTC milliseconds.

  • Changed property delegatedToEmail (object)

    The email address of the delegated administrator.

  • Changed property delegatedToName (object)

    The name of the delegated administrator.

  • Changed property delegationType (object)

    The type of delegation relationship.

  • Changed property earlyExpirationDate (object)

    The early expiration date for the delegation.

  • Changed property entitlements (object)

    The list of license entitlements for the delegation.

  • Changed property id (object)

    The unique identifier of the delegation.

  • Changed property status (object)

    The current status of the delegation.

  • Changed property switchLicenses (object)

    The total number of switch licenses.

  • Changed property tenantEmail (object)

    The email address of the tenant account.

  • Changed property tenantId (object)

    The unique identifier of the tenant account.

  • Changed property tenantName (object)

    The name of the tenant account.

  • Changed property type (object)

    The account type of the delegation.

  • Changed property wifiLicenses (object)

    The total number of WiFi licenses.

  • Changed property priorityIncidents (object)

    Count of support incidents categorized by priority level.

    • Changed property p1 (object)

      Number of priority 1 (critical) incidents.

    • Changed property p2 (object)

      Number of priority 2 (high) incidents.

    • Changed property p3 (object)

      Number of priority 3 (medium) incidents.

    • Changed property p4 (object)

      Number of priority 4 (low) incidents.

POST /mspecs/query

Query Customer Data for MSP-EC

Request:

• Changed content type : application/json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

• Changed content type : application/vnd.ruckus.v1+json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

Return Type:

• Deleted response : 401 Unauthorized

Unauthorized

• Deleted response : 403 Forbidden

Forbidden

• Deleted response : 422 Unprocessable Entity

Validation error

• Deleted response : 500 Internal Server Error

Internal Server Error

• Deleted response : 501 Not Implemented

not implemented

• Changed response : 400 Bad Request

Bad request.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 404 Not Found

Requested resource or related entity not found.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 200 OK

Successful operation.

• Changed content type : application/json

  • Changed property errorMessage (object)

    Error message if the query execution failed, null if successful.

  • Changed property fields (object)

    List of MSP-EC account objects returned in the query response.

  • Changed property objectId (object)

    Unique identifier for the query response object.

  • Changed property subsequentQueries (object)

    Pagination links for retrieving subsequent pages of query results.

  • Changed property totalCount (object)

    Total number of MSP-EC accounts matching the query criteria across all pages.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property errorMessage (object)

    Error message if the query execution failed, null if successful.

  • Changed property fields (object)

    List of MSP-EC account objects returned in the query response.

  • Changed property objectId (object)

    Unique identifier for the query response object.

  • Changed property subsequentQueries (object)

    Pagination links for retrieving subsequent pages of query results.

  • Changed property totalCount (object)

    Total number of MSP-EC accounts matching the query criteria across all pages.

POST /msps/{mspTenantId}/ecInventories/query

Query Inventory for MSP

Request:

• Changed content type : application/json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

• Changed content type : application/vnd.ruckus.v1+json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

Return Type:

• Deleted response : 401 Unauthorized

Unauthorized

• Deleted response : 403 Forbidden

Forbidden

• Deleted response : 422 Unprocessable Entity

Validation error

• Deleted response : 500 Internal Server Error

Internal Server Error

• Deleted response : 501 Not Implemented

not implemented

• Changed response : 400 Bad Request

Bad request.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 404 Not Found

Requested resource or related entity not found.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 200 OK

Successful operation.

• Changed content type : application/json

  • Changed property errorMessage (object)

    Error message if the query execution failed, null if successful.

  • Changed property fields (object)

    List of MSP inventory device objects returned in the query response.

  • Changed property objectId (object)

    Unique identifier for the query response object.

  • Changed property subsequentQueries (object)

    Pagination links for retrieving subsequent pages of query results.

  • Changed property totalCount (object)

    Total number of devices matching the query criteria across all pages.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property errorMessage (object)

    Error message if the query execution failed, null if successful.

  • Changed property fields (object)

    List of MSP inventory device objects returned in the query response.

  • Changed property objectId (object)

    Unique identifier for the query response object.

  • Changed property subsequentQueries (object)

    Pagination links for retrieving subsequent pages of query results.

  • Changed property totalCount (object)

    Total number of devices matching the query criteria across all pages.

POST /msps/{mspTenantId}/ecInventories/query/csvFiles

Export End Customer Inventory

Request:

• Changed content type : application/json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

• Changed content type : application/vnd.ruckus.v1+json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

Return Type:

• Deleted response : 401 Unauthorized

Unauthorized

• Deleted response : 403 Forbidden

Forbidden

• Deleted response : 422 Unprocessable Entity

Validation error

• Deleted response : 500 Internal Server Error

Internal Server Error

• Deleted response : 501 Not Implemented

not implemented

• Changed response : 400 Bad Request

Bad request.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 404 Not Found

Requested resource or related entity not found.

• New content type : application/json

• New content type : application/vnd.ruckus.v1+json

• Changed response : 200 OK

Successful operation.

• Changed content type : application/json

• Changed content type : application/vnd.ruckus.v1+json

POST /techpartners/mspecs/query

Query Technology Partners

Request:

• Changed content type : application/json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.

• Changed content type : application/vnd.ruckus.v1+json

• Added property search_after (object)

  Pagination cursor for retrieving results after a specific point in the result set.

• Changed property exists (object)

  Field name to check for existence in documents.

• Changed property fields (object)

  List of specific fields to include in the query results for projection.

• Changed property filters (object)

  Additional custom filters to apply to the query for advanced filtering scenarios.

• Changed property groupBy (object)

  Field name to group query results by for aggregation purposes.

• Changed property matchFields (object)

  List of field filters to match documents where fields equal specific values.

• Changed property multiSortFields (object)

  List of fields to sort by with their sort order for multiple field sorting.

• Changed property mustHaveFields (object)

  List of fields that must exist in documents for them to be included in results.

• Changed property mustNotHaveFields (object)

  List of fields that must not exist in documents for them to be included in results.

• Changed property mustNotMatchField (object)

  List of field filters to exclude documents where fields equal specific values.

• Changed property pageByDate (object)

  Indicates whether pagination should be based on date fields instead of standard pagination.

• Changed property pageSize (object)

  Maximum number of results to return per page.

• Changed property searchString (object)

  Text string to search for across the specified target fields.

• Changed property searchTargetFields (object)

  List of fields to search within when performing text based searches.

• Changed property sortField (object)

  Primary field name to sort the query results by.

• Changed property sortOrder (object)

  Sort order for the primary sort field (ASC for ascending, DESC for descending).

• Changed property terms (object)

  List of term values to match against the specified term field.

• Changed property rangeDateFilter (object)

  Query filter to match documents where a field value falls within a specified range.

  • Changed property field (object)

    Name of the field to apply the range filter on.

  • Changed property gte (object)

    Greater than or equal to value for the range filter (inclusive lower bound).

  • Changed property lt (object)

    Less than value for the range filter (exclusive upper bound).

  • Changed property lte (object)

    Less than or equal to value for the range filter (inclusive upper bound).

• Changed property termField (object)

  Query filter to match documents containing specific term values in a field.

  • Changed property field (object)

    Name of the field to match against the list of term values.