Skip to main content

Retrieves one change request by id

GET 
/api/admin/projects/:projectId/change-requests/:id

This endpoint will retrieve one change request if it matches the provided id.

Request​

Path Parameters

    projectId stringrequired
    id stringrequired

Responses​

changeRequestSchema

Schema

    oneOf

    id numberrequired

    This change requests's ID.

    Example: 3
    title string

    A title describing the change request's content.

    Example: Increasing gradual rollout
    environment stringrequired

    The environment in which the changes should be applied.

    Example: development
    minApprovals numberrequired

    The minimum number of approvals required before this change request can be applied.

    Example: 2
    project stringrequired

    The project this change request belongs to.

    Example: unleash-project

    features

    object[]

    required

    The list of features and their changes that relate to this change request.

  • Array [

    • name stringrequired

    The name of the feature

    Example: my-feature
    conflict string

    A string describing the conflicts related to this change. Only present if there are any concflicts on the feature level.

    Example: Feature has been archived

    changes

    object[]

    required

    List of changes inside change request. This list may be empty when listing all change requests for a project.

  • Array [

    • id numberrequired

    The ID of this change.

    Example: 33
    action stringrequired

    The kind of action that the change contains information about.

    Example: updateStrategy
    conflict string

    A description of the conflict caused by this change. Only present if there are any conflicts.

    Example: Strategy has been deleted

    payload

    object

    required

    The data required to perform this action.

    oneOf

    string

    createdBy

    object

    The user who created this change.

    username stringnullable

    The user's username.

    imageUrl urinullable

    The URL where the user's image can be found.

    createdAt date-time

    When this change was suggested

    Example: 2023-07-31T13:22:03+02:00

  • ]

    • defaultChange

    object

    A description of a default change that will be applied with the change request to prevent invalid states.

    Default changes are changes that are applied in addition to explicit user-specified changes when a change request is applied. Any default changes are applied in the background and are not a real part of the change request.

    action stringrequired

    The kind of action this is.

    Example: addStrategy
    payload objectrequired

    The necessary data to perform this change.

    Example: {"name":"flexibleRollout","title":"","disabled":false,"segments":[],"parameters":{"groupId":"my-feature","rollout":"100","stickiness":"default"},"constraints":[{"values":["ux"],"inverted":false,"operator":"STR_CONTAINS","contextName":"userId","caseInsensitive":false}]}

  • ]

    • segments

    object[]

    required

    The list of segments and their changes that relate to this change request.

  • Array [

    • id numberrequired

    The ID of this change.

    Example: 33
    action stringrequired

    The kind of action that the change contains information about.

    Example: updateStrategy
    conflict string

    A description of the conflict caused by this change. Only present if there are any conflicts.

    Example: Strategy has been deleted

    payload

    object

    required

    The data required to perform this action.

    oneOf

    string

    createdBy

    object

    The user who created this change.

    username stringnullable

    The user's username.

    imageUrl urinullable

    The URL where the user's image can be found.

    createdAt date-time

    When this change was suggested

    Example: 2023-07-31T13:22:03+02:00
    name stringrequired

    The current name of the segment

    Example: beta-users

  • ]

    • approvals

    object[]

    A list of approvals that this change request has received.

  • Array [

    • createdBy

    object

    required

    Information about the user who gave this approval.

    id number

    The ID of the user who gave this approval.

    Example: 33
    username string

    The approving user's username.

    Example: unleash-user
    imageUrl uri

    The URL where the user's image can be found.

    createdAt date-timerequired

    When the approval was given.

    Example: 2022-12-12T12:13:24.218Z

  • ]

    • rejections

    object[]

    A list of rejections that this change request has received.

  • Array [

    • createdBy

    object

    required

    Information about the user who gave this approval.

    id number

    The ID of the user who gave this approval.

    Example: 33
    username string

    The approving user's username.

    Example: unleash-user
    imageUrl uri

    The URL where the user's image can be found.

    createdAt date-timerequired

    When the approval was given.

    Example: 2022-12-12T12:13:24.218Z

  • ]

    • comments

    object[]

    All comments that have been made on this change request.

  • Array [

    • id number

    The comment's ID. Unique per change request.

    Example: 33
    text stringrequired

    The content of the comment.

    Example: This is a comment

    createdBy

    object

    required

    Information about the user who posted the comment

    username stringnullable

    The user's username.

    Example: unleash-user
    imageUrl urinullable

    The URL where the user's image can be found.

    createdAt date-timerequired

    When the comment was made.

    Example: 2022-12-12T12:13:24.218Z

  • ]

    • createdBy

    object

    required

    The user who created this change request.

    username stringnullable
    Example: Hunter
    imageUrl urinullable

    The URL of the user's profile image.

    createdAt date-timerequired

    When this change request was created.

    Example: 2023-07-31T13:33:02Z
    state stringrequired

    The current state of the change request.

    Possible values: [Draft, In review, Approved, Applied, Cancelled, Rejected]

Loading...