Model: ChangeHistoryChange

1 min

Model Parameters

ChangeHistoryChange
- change_typestring<archive | create | update | delete | publish>
  Description
  Action performed on the entity.
  Allowed
  archivecreateupdatedeletepublish
- changesChangeDetail[]
  Description
  List of change details.
  - after
    Description
    Value of the property after modification.
  - before
    Description
    Value of the property before modification.
  - descriptionstring
    Description
    Human readable description of the change.
  - propertystring
    Description
    The name of the property modified.
- createdstring<date-time>
  Description
  Created time of the current revision. Format is ISO 8601.
  Format
  date-time
- entityEntity
  - api_urlstring<url>
    Description
    Generated URL to access the entity by using the public API.
    Format
    url
  - idinteger<int64>
    Description
    ID of the entity.
    Format
    int64
  - namestring
    Description
    Name of the entity.
  - sub_typestring
    Description
    Optional field for entities that have sub_types (projects, experiments, extensions, pages, etc)
  - typestring
    Description
    Type of the entity as defined by the public API.
  - ui_urlstring<url>
    Description
    Generated URL to access the entity using Optimizely UI.
    Format
    url
- idinteger<int64>
  Description
  ID of the change.
  Format
  int64
- project_idinteger<int64>required
  Description
  ID of the project related to the entity.
  Format
  int64
- revisionsChangeRevision
  - currentRevision
    - idinteger
      Description
      Reference to a revision of the entity.
  - previousRevision
    - idinteger
      Description
      Reference to a revision of the entity.
- sourcestring<ui | api>
  Description
  Origin of the current revision.
  Allowed
  uiapi
- summarystring
  Description
  Short human readable description of the change.
- userUser
  - display_namestring
    Description
    Display name of the user, most commonly the Optimizely user's email.
  - emailstringrequired
    Description
    Email of the user.
  - first_namestring
    Description
    First name of the user.
  - idstringrequired
    Description
    ID of the user.
  - last_namestring
    Description
    Last name of the user.
  - profile_image_urlstring
    Description
    URL to the user profile image.