M3m3ter-com
CustomField

Update CustomFields

Changed on

Update Custom Fields added at Organization level to entities that support them.

put/organizations/{orgId}/customfields

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

Updates to Organization CustomFields.

accountobject

Updates to Account entity CustomFields.

accountPlanobject

Updates to AccountPlan entity CustomFields.

meterobject

Updates to Meter entity CustomFields.

productobject

Updates to Product entity CustomFields.

planTemplateobject

Updates to planTemplate entity CustomFields.

planobject

Updates to Plan entity CustomFields.

aggregationobject

Updates to simple Aggregation entity CustomFields.

compoundAggregationobject

Updates to Compound Aggregation entity CustomFields.

contractobject

Updates to Contract entity CustomFields.

Example request

{
  "version": 6,
  "organization": {
    "Org Example 2": "Sample text 2.",
    "Org Example 1": "Sample text 1."
  },
  "account": {},
  "accountPlan": {
    "New CF Test": "Test Value"
  },
  "meter": {},
  "product": {
    "Product CF Example": 42
  },
  "planTemplate": {},
  "plan": {},
  "aggregation": {},
  "compoundAggregation": {}
}

Response

Return the updated CustomFields

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

CustomFields added to the Organization.

accountobject

CustomFields added to Account entities.

accountPlanobject

CustomFields added to accountPlan entities.

meterobject

CustomFields added to Meter entities.

productobject

CustomFields added to Product entities.

planTemplateobject

CustomFields added to planTemplate entities.

planobject

CustomFields added to Plan entities.

aggregationobject

CustomFields added to simple Aggregation entities.

compoundAggregationobject

CustomFields added to Compound Aggregation entities.

contractobject

CustomFields added to Contract entities.

dtCreatedstring date-time

The DateTime when the Organization was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when a custom field was last modified - created, modified, or deleted - for the Organization (in ISO-8601 format).

createdBystring

The id of the user who created this custom field.

lastModifiedBystring

The id of the user who last modified this custom field.

Example response

{
  "id": "81c49a54-dfcd-4da5-bbf3-d2885ec025dd",
  "version": 4,
  "organization": {
    "Org Example 2": "Sample text 2.",
    "Org Example 1": "Sample text. "
  },
  "product": {
    "Product CF Example": 42
  },
  "account": {},
  "accountPlan": {
    "New CF Test": "Test Value"
  },
  "meter": {},
  "planTemplate": {},
  "plan": {},
  "aggregation": {},
  "compoundAggregation": {}
}

Changes

  • 85c514abc692Revision changes
    • 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

  • 9f9e5f3dbde7Revision changes
    • breaking

      the response property //// became optional for the status

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status