Lookups

Resource Representation ↑

Example:
{
  "id": 1,
  "name": "Colors",
  "columns": ["Color", "Color Family"]
}

Supported Formats

json
>>>

GET /api/v2/lookups
List lookups

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
      {
        "id": 1,
        "name": "Colors",
        "columns": ["Color", "Color Family"]
      }
    ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
lang
optional

Language code for translated value

Validations:

  • Must be a String
>>>

POST /api/v2/lookups
Create an lookup

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "lookup": {
          "name": "Colors",
          "columns": ["Color","Color Family"],
          "rows": [
            {"values": ["Red", "red"]},
            {"values": ["Blue", "blue"]}
          ]
      }
  }

response:
  {
    "id": 1,
    "name": "Colors",
    "columns": ["Color","Color Family"]
  }

Params

Param name Description
lookup
required

Validations:

  • Must be a Hash
lookup[name]
required

Name of the lookup

Validations:

  • Must be a String
lookup[columns]
optional , nil allowed

Column names

Validations:

  • Must be an array of String
lookup[rows]
optional , nil allowed

Lookup rows

Validations:

  • Must be an Array of nested elements
lookup[rows][values]
optional , nil allowed

Row values

Validations:

  • Must be an array of String
>>>

PUT /api/v2/lookups/:id
Update an lookup

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "lookup": {
        "name": "Colors Updated",
        "rows": [
            {"values": ["White", "white"]},
            {"values": ["Black", "black"]}
        ]
    }
  }

response:
  {
    "id": 1,
    "name": "Colors Updated",
    "columns": ["Color","Color Family"]
  }

Params

Param name Description
lookup
required

Validations:

  • Must be a Hash
lookup[name]
optional

Name of the lookup

Validations:

  • Must be a String
lookup[columns]
optional , nil allowed

Column names

Validations:

  • Must be an array of String
lookup[rows]
optional , nil allowed

Lookup rows

Validations:

  • Must be an Array of nested elements
lookup[rows][values]
optional , nil allowed

Row values

Validations:

  • Must be an array of String
>>>

DELETE /api/v2/lookups/:id
Delete an lookup

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 1
  }
>>>

POST /api/v2/lookups/:id/search
Lookup the rows by given column values

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "conditions": [
        {"column": "Color", "value": "Red"}
    ]
  }

response:
  {
    "id": 1,
    "name": "Colors",
    "rows": [{"Color": "Red", "Color Family": "red"}]
  }
>>>

GET /api/v2/lookups/:id
Lookup by id

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 1,
    "name": "Colors",
    "rows": [{"Color": "Red", "Color Family": "red"}]
  }