Skip to main content
GET
/
organizations
/
{orgId}
/
lookuptables
/
{lookupTableId}
/
revisions
/
{id}
Retrieve LookupTableRevision
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/lookuptables/{lookupTableId}/revisions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "customFields": {},
  "name": "<string>",
  "status": "DRAFT",
  "startDate": "2023-11-07T05:31:56Z",
  "fields": [
    {
      "type": "STRING",
      "name": "<string>"
    }
  ],
  "keys": [
    "<string>"
  ],
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "itemCount": 123
}

Authorizations

Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

orgId
string
required

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

id
string
required

The UUID of the Lookup Table Revision to retrieve.

lookupTableId
string
required

The UUID of the Lookup Table the Revision belongs to.

Response

Returns the LookupTableRevision

Response containing a LookupTableRevision entity

id
string
required

The UUID of the entity.

version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
customFields
object

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

name
string

The name of the Lookup Table Revision.

status
enum<string>
Available options:
DRAFT,
PUBLISHED,
ARCHIVED
startDate
string<date-time>

The start date of the Lookup Table Revision

fields
object[]

The list of fields of the Lookup Table Revision.

keys
string[]

The ordered keys of the Lookup Table Revision

dtCreated
string<date-time>

The DateTime when the Lookup Table Revision was created.

dtLastModified
string<date-time>

The DateTime when the Lookup Table Revision was last modified.

createdBy
string

The id of the user who created the Lookup Table Revision.

lastModifiedBy
string

The id of the user who last modified the Lookup Table Revision.

itemCount
integer<int64>