Get scheduled change requests matching a query.

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

This endpoint retrieves basic information about all scheduled change requests that match the search criteria provided in the query parameters. The endpoint will return any change request that matches one or more of the provided parameters. If you use no query parameters, you'll get an empty list.

For instance, to find all the scheduled change requests that either touch feature MyFeature or strategy 0D198067-7D55-460C-9EC7-DB86E3AE261A, you would use the query string feature=MyFeature&strategyId=0D198067-7D55-460C-9EC7-DB86E3AE261A.

Request

Path Parameters

• projectId string required

Responses

• 200
• 404

---

changeRequestScheduledResultSchema

application/json

Schema

Schema

• Array [
• id number required

  The change request id

• environment string required

  The environment of the change request

• title string

  The change request title

• ]

Example (from schema)

[
  {
    "id": 1,
    "environment": "production",
    "title": "My awesome change"
  }
]

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...