Skip to content

dataset.plan

Manage dataset plans

Create

Path
POST /v7.0/datasets/{dataset_id}/plans
Description
Assign new dataset plan
Authentication required
yes
Scope
dataset.plan#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
plan
ParameterTypeRequiredDetails
environment_dataset_plan
Environment_dataset_plan
 Resource yes

Output parameters

Layout
object
Namespace
plan
ParameterTypeDescription
id
Id
 Integer
environment_dataset_plan
Environment_dataset_plan
 Resource

Delete

Path
DELETE /v7.0/datasets/{dataset_id}/plans/{plan_id}
Description
Remove dataset plan
Authentication required
yes
Scope
dataset.plan#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/datasets/{dataset_id}/plans
Description
Authentication required
yes
Scope
dataset.plan#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
plan
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
plans
ParameterTypeDescription
id
Id
 Integer
environment_dataset_plan
Environment_dataset_plan
 Resource

Show

Path
GET /v7.0/datasets/{dataset_id}/plans/{plan_id}
Description
Show dataset plan
Authentication required
yes
Scope
dataset.plan#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
plan
ParameterTypeDescription
id
Id
 Integer
environment_dataset_plan
Environment_dataset_plan
 Resource