Create a Schedule Change for a flag in an environment

1 min

POST

http://localhost:3002//projects/{project_id}/flags/{flag_key}/schedules

Create a Scheduled Change for a flag in an environment The schedule change contains a set of actions to update the flag in that environment at a specific time

Path Parameters

project_idintegerrequired
flag_keystringrequired

Body Parameters

bodyScheduledChangeCreateRequestrequired
- account_idintegerrequired
  Description
  The account the Project is associated with.
- actionsScheduleAction[]required
  Description
  Schedule action details.
  - subjectobjectrequired
    Description
    The entity this action will apply to
    - keystring
      Description
      The identifier of the subject
    - typestring<flag | rule>
      Description
      The type of subject. Can be a flag or a rule of the flag
      Allowed
      flagrule
  - changed_elementstring<status | percentage_included | audience_conditions>required
    Allowed
    statuspercentage_includedaudience_conditions
  - valueActionValuerequired
    Description
    Value of the action. Can be of any type.
    - object
    - object
- scheduleobjectrequired
  Description
  Schedule details.
  - ScheduledTime
    - timestringrequired
      Example
      1214
      Description
      The schedule will run at this time. Expected format: hh
      (24 hour)
    - time_zonestringrequired
      Example
      Etc/UTC
      Description
      The timezone information for the scheduled time. Must be an IANA timezone.
    - datestringrequired
      Example
      2023-07-30
      Description
      The schedule will run at this date. Expected format: yyyy-mm-dd.
- environmentstringrequired
- approval_requiredboolean
- reasonstring

Responses

201Successful Response

ScheduledChange
- idintegerrequired
  Description
  The unique identifier for the schedule.
- account_idintegerrequired
  Description
  The account the Project is associated with.
- project_idintegerrequired
  Description
  The id of the project for which the schedule is set.
- flag_keystringrequired
  Description
  The Flag identifier
- environmentstringrequired
  Description
  The Environment of the flag
- actionsScheduleAction[]required
  Description
  Schedule actions.
  - subjectobjectrequired
    Description
    The entity this action will apply to
    - keystring
      Description
      The identifier of the subject
    - typestring<flag | rule>
      Description
      The type of subject. Can be a flag or a rule of the flag
      Allowed
      flagrule
  - changed_elementstring<status | percentage_included | audience_conditions>required
    Allowed
    statuspercentage_includedaudience_conditions
  - valueActionValuerequired
    Description
    Value of the action. Can be of any type.
    - object
    - object
- scheduleobjectrequired
  Description
  Schedule details.
  - ScheduledTimeWithUTC
    - timestringrequired
      Example
      07:02
      Description
      The schedule will run at this time. Expected format: hh
      (24 hour)
    - time_zonestringrequired
      Example
      Etc/UTC
      Description
      The timezone information for the scheduled time. Must be an IANA timezone.
    - datestringrequired
      Example
      2023-07-30
      Description
      The schedule will run at this date. Expected format: yyyy-mm-dd.
    - utc_timestringrequired
      Example
      2023-07-30T07:02:00+0000
      Description
      The utc timestamp when the scheduled job will be executed.
- statusstringrequired
  Description
  The status of the scheduled job.
- approval_statusstring<pending | accepted | rejected | withdrawn>
  Description
  The current approval status for a change-request-backed schedule. Present only when approval is required; null for non-gated or pure-legacy schedules.
  Allowed
  pendingacceptedrejectedwithdrawn
- completed_atstring<date-time>required
  Example
  2023-04-15T20:14+0000
  Description
  The UTC timestamp when the schedule is completed.
  Format
  date-time
- updated_atstring<date-time>required
  Example
  2023-04-15T20:14+0000
  Description
  The UTC timestamp when the schedule is updated.
  Format
  date-time
- created_atstring<date-time>required
  Example
  2023-04-15T20:14+0000
  Description
  The UTC timestamp when the schedule is created.
  Format
  date-time
- updated_bystringrequired
  Description
  The user who updated the schedule.
- created_bystringrequired
  Description
  The user who created the schedule.

401Not Authenticated

ErrorResponse
Example
```
{
  "details": "Not authenticated",
  "status": 401
}
```
- detailsstringrequired
  Description
  Details of Error.
- statusintegerrequired
  Example
  400
  Description
  Status code of the response.

422Validation Error

HTTPValidationError
- detailValidationError[]
  - locobject[]required
    Description
    Path to the invalid value
  - msgstringrequired
    Description
    Error message
  - typestringrequired
    Description
    Error type
- statusinteger
  Example
  422
  Description
  Status code of the response.

curl

curl --request POST \
     --url http://localhost:3002//projects/{project_id}/flags/{flag_key}/schedules \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "account_id": "",
     "actions": [
     {
     "subject": {},
     "changed_element": "",
     "value": {}
     }
     ],
     "schedule": {
     "time": 1214,
     "time_zone": "Etc/UTC",
     "date": "2023-07-30"
     },
     "environment": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "account_id": "",
   "actions": [
      {
         "subject": {},
         "changed_element": "",
         "value": {}
      }
   ],
   "schedule": {
      "time": 1214,
      "time_zone": "Etc/UTC",
      "date": "2023-07-30"
   },
   "environment": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("http://localhost:3002//projects/{project_id}/flags/{flag_key}/schedules", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("http://localhost:3002//projects/{project_id}/flags/{flag_key}/schedules")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "account_id": "",
   "actions": [
      {
         "subject": {},
         "changed_element": "",
         "value": {}
      }
   ],
   "schedule": {
      "time": 1214,
      "time_zone": "Etc/UTC",
      "date": "2023-07-30"
   },
   "environment": ""
})

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "http://localhost:3002//projects/{project_id}/flags/{flag_key}/schedules"

payload = json.dumps({
   "account_id": "",
   "actions": [
      {
         "subject": {},
         "changed_element": "",
         "value": {}
      }
   ],
   "schedule": {
      "time": 1214,
      "time_zone": "Etc/UTC",
      "date": "2023-07-30"
   },
   "environment": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Successful Response
{
  "id": 0,
  "account_id": 0,
  "project_id": 0,
  "flag_key": "",
  "environment": "",
  "actions": [
    {
      "subject": {
        "key": "",
        "type": ""
      },
      "changed_element": "",
      "value": {}
    }
  ],
  "schedule": {},
  "status": "",
  "approval_status": "",
  "completed_at": "2023-04-15T20:14+0000",
  "updated_at": "2023-04-15T20:14+0000",
  "created_at": "2023-04-15T20:14+0000",
  "updated_by": "",
  "created_by": ""
}

401

// Not Authenticated
{
  "details": "",
  "status": 400
}

422

// Validation Error
{
  "detail": [
    {
      "loc": [
        {}
      ],
      "msg": "",
      "type": ""
    }
  ],
  "status": 422
}