Copy Schedule To Environment

POST 
/v1/product/:product_id/environment/:environment_id/schedule/:schedule_id/copy

Copy a schedule to an environment, either as a sync or full copy

Request

Path Parameters

product_id uuidrequired

The product ID

environment_id uuidrequired

The environment ID

schedule_id uuidrequired

The schedule ID to copy

Query Parameters

sync Sync

If True, sync schedule. If False, create full copy

Responses

200

Successful Response

application/json

Schema

Schema

anyOf

EnvironmentScheduleEntryResponse

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when this resource was created

name Name (string)

Name of the event

description Description (string)

Description of the event

start_datetime date-timerequired

Start datetime of the event

created_by_account_id uuid

ID of the account that created the event

schedule_id uuidrequired

Unique identifier for the event

ScheduleCopyResponse

Response model for schedule copy operation.

schedule

object

required

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when this resource was created

name Name (string)

Name of the event

description Description (string)

Description of the event

start_datetime date-timerequired

Start datetime of the event

created_by_account_id uuid

ID of the account that created the event

schedule_id uuidrequired

Unique identifier for the event

modifications

object[]

required

Array [

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when this resource was created

target_id Target Id (string)required

Unique identifier for the target

target_type Target Type (string)required

Type of entity being modified

field_name Field Name (string)required

Name of the field being modified

value_boolean Value Boolean (boolean)

Boolean value modification

value_string Value String (string)

String value modification

value_integer Value Integer (integer)

Integer value modification

value_float Value Float (number)

Float value modification

value_datetime date-time

Datetime value modification

name Name (string)

Name of the modification

description Description (string)

Description of the modification

reference_sandbox_id uuid

ID of the sandbox of which the modification originated

model_config object

Default value: [object Object]

delete_overlay_mod Delete Overlay Mod (boolean)

Whether to delete the overlay modification from the overlay.

schedule_id uuidrequired

ID of the parent event

modification_id uuidrequired

Unique identifier for the modification

product_id uuidrequired

Unique product identifier for the modification

]

Example (from schema)

{}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...