KB86259
Published: August 1, 2017
Revision: 2.0

SNAP PAC RESTful API: The value in a 1-element table may be returned as a key-value pair instead of as an array


Applies To:

SNAP-PAC-S1
SNAP-PAC-S1-FM
SNAP-PAC-S1-W
SNAP-PAC-S2
SNAP-PAC-S2-W
SNAP-PAC-R1
SNAP-PAC-R1-FM
SNAP-PAC-R1-W
SNAP-PAC-R1-B
SNAP-PAC-R2
SNAP-PAC-R2-FM
SNAP-PAC-R2-W

Versions Affected:

Versions affected: PAC firmware R9.5a through R9.5d
Problem is fixed in version: FW R9.5e

Resolved In Version:

Problem is fixed in version: FW R9.5e


Symptoms:

When using the SNAP PAC RESTful API to get the value in a 1-element table, if you add a slash ( / ) to the end of the request*, the controller may return the value formatted as a key-value pair. Instead, the controller should return the value formatted as an array.

For example, when a table has only one element, a request like this:
/device/strategy/tables/int32s/MyTable/
...may return the response as a key-value pair—like this:
{
  value: 6
}

Instead, the response should be formatted as an array—like this:
[
  6
]

Note: If you don't put the slash at the end of the request, the controller correctly formats the returned value.

*A request is a URL that follows the syntax for the SNAP PAC REST API.  It's also known as an "endpoint."

Resolution:

Opto 22 has resolved this issue.

Questions?

Contact: Opto 22 Product Support.
Phone: 800-835-6786 or 951-695-3080
Email: support@opto22.com


DISCLAIMER

This Opto 22 Knowledge Base ('OptoKB') article is intended to provide general technical information on a particular subject or subjects and is not an exhaustive treatment of such subjects. Accordingly, the information in this OptoKB article is not intended to constitute application, design, software, or other professional engineering advice or services. Opto 22 may modify the OptoKB articles at any time. Before making any decision or taking any action which might affect your equipment, you should consult a qualified professional.

OPTO 22 DOES NOT WARRANT THE COMPLETENESS, TIMELINESS, OR ACCURACY OF THE DATA CONTAINED IN THIS OPTOKB ARTICLE AND MAY MAKE CHANGES THERETO AT ANY TIME AT ITS SOLE DISCRETION WITHOUT NOTICE. FURTHER, ALL INFORMATION CONVEYED HEREBY IS PROVIDED TO USERS 'AS IS.' IN NO EVENT SHALL OPTO 22 BE LIABLE FOR ANY DAMAGES OF ANY KIND INCLUDING DIRECT, INDIRECT INCIDENTAL, CONSEQUENTIAL, LOSS PROFIT, OR DAMAGE, EVEN IF OPTO 22 HAS BEEN ADVISED ON THE POSSIBILITY OF SUCH DAMAGES.

OPTO 22 DISCLAIMS ALL WARRANTIES WHETHER EXPRESSED OR IMPLIED WITH RESPECT TO THE INFORMATION (INCLUDING HARDWARE, SOFTWARE, AND/OR FIRMWARE) PROVIDED HEREBY, INCLUDING THE IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTIBILITY, AND NON-INFRINGEMENT. Note that certain jurisdictions do not sanction the exclusion of implied warranties: thus, this disclaimer may not apply to you.

Copyright © 2019 Opto 22. All rights reserved.