LookupTable

List LookupTable

Changed on

Retrieve a list Lookup Tables created for the Organization:

  • Returned list can be filtered by Lookup Table code query parameter.
  • If you want to include any non-default fields for the returned Lookup Tables, use the additional query parameter to specify which you want to include in the response.
get/organizations/{orgId}/lookuptables

Request

Path parameters

orgIdstring required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Query parameters

pageSizeinteger

Number of Lookup Tables to retrieve per page.

nextTokenstring

Token to supply for multi page retrievals.

codesstring[]

List of Lookup Table codes to retrieve.

additionalstring[]

Comma separated list of additional non-default fields to be included in the response. For example,if you want to include the active Revision for each of the Lookup Tables returned, set additional=activeRevision in the query.

Response

List of Lookup Tables

nextTokenstring

Example response

{
  "data": [
    {
      "activeRevision": {
        "fields": [
          {
            "name": "lookuptablerevisionfieldkey"
          }
        ]
      }
    }
  ]
}

Changes

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the //////////// response's property type changed from no type to object for status

    • info

      added the optional property //////// to the response with the status

    • info

      removed subschema #2 from the /// response property allOf list for the response status

    • info

      removed subschema #2 from the ////////// response property allOf list for the response status

    • info

      removed subschema #2 from the //////// response property allOf list for the response status

    • info

      endpoint added