Skip to main content
POST
/
organizations
/
{orgId}
/
lookuptables
/
{lookupTableId}
/
revisions
Create LookupTableRevision
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/lookuptables/{lookupTableId}/revisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "fields": [
    {
      "name": "lookuptablerevisionfieldkey"
    }
  ],
  "keys": [
    "foo",
    "bar"
  ],
  "version": 123,
  "customFields": {},
  "startDate": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "version": 123,
  "customFields": {},
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "fields": [
    {
      "name": "lookuptablerevisionfieldkey"
    }
  ],
  "keys": [
    "<string>"
  ],
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "itemCount": 123,
  "lookupTableId": "<string>"
}

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.

​
lookupTableId
string
required

UUID of the Lookup Table the Revision will be created for.

Body

application/json

Request containing a LookupTableRevision entity

​
name
string
required

Descriptive name for the Lookup Table Revision.

Required string length: 1 - 200
​
fields
object[]
required

The list of fields of the Lookup Table Revision.

Required array length: 2 - 10 elements
​
keys
string[]
required

The ordered keys of the Lookup Table Revision.

Required array length: 1 - 5 elements
Example:
["foo", "bar"]
​
version
integer<int64>

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed 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.

​
startDate
string<date-time>

The start date of the Lookup Table Revision.

Response

Returns the created Lookup Table Revision

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>
​
lookupTableId
string

The lookup table id associated with this revision