M3m3ter-com
LookupTable

Create LookupTable

Changed on

Create a new Lookup Table.

post/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.

Request body

versioninteger

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.
customFieldsobject

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.

namestring required

Descriptive name for the Lookup Table.

codestring required

Code of the Lookup Table - unique short code used to identify the Lookup Table.

NOTE: Code has a maximum length of 80 characters and must not contain non-printable or whitespace characters (except space), and cannot start/end with whitespace.

Response

Return the created Lookup Table

idstring required

The UUID of the entity.

versioninteger

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.
customFieldsobject

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.

namestring

The name of the Lookup Table

codestring

The code of the Lookup Table

dtCreatedstring date-time

The DateTime when the Lookup Table was created.

dtLastModifiedstring date-time

The DateTime when the Lookup Table was last modified.

createdBystring

The id of the user who created this Lookup Table.

lastModifiedBystring

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

Example response

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

Changes

  • 85c514abc692Revision changes
    • breaking

      added subschema #1 subschema #2 to the ///// request property allOf list

    • breaking

      the //// request property type changed from no type to object

    • breaking

      the request property type changed from no type to object

    • 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

      the request property / became optional

    • info

      the request property / became optional

    • 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

  • ac93d1a9e6d9Revision changes
    • info

      endpoint added