M3m3ter-com
PlanGroupLink

Create PlanGroupLink

Changed on

Create a new PlanGroupLink.

post/organizations/{orgId}/plangrouplinks

Request

Path parameters

orgIdstring required

UUID of the organization

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.
planGroupIdstring required
planIdstring required

Response

Return the created PlanGroupLink

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

ID of the linked PlanGroup

planIdstring

ID of the linked Plan

dtCreatedstring date-time

The DateTime (in ISO-8601 format) when the plan group link was created.

dtLastModifiedstring date-time

The DateTime (in ISO-8601 format) when the plan group link was last modified.

createdBystring

The id of the user who created this plan group link.

lastModifiedBystring

The id of the user who last modified this plan group link.

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