environment.dataset_plan

Manage environment dataset plans

Index

Path: GET /v7.0/environments/{environment_id}/dataset_plans
Description: List dataset plans
Authentication required: yes
Scope: environment.dataset_plan#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: dataset_plan

Parameter Type Required Details

from_id

From ID

Integer

no

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
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
Rule	Details
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: dataset_plans

Parameter	Type	Description
`id` ID	Integer
`label` Label	String
`dataset_plan` DatasetPlan	Resource
`user_add` User add	Boolean	If true, the user can add this plan to a dataset
`user_remove` User remove	Boolean	If true, the user can remove this plan from a dataset

Show

Path: GET /v7.0/environments/{environment_id}/dataset_plans/{dataset_plan_id}
Description: Show dataset plan
Authentication required: yes
Scope: environment.dataset_plan#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: dataset_plan

Parameter	Type	Description
`id` ID	Integer
`label` Label	String
`dataset_plan` DatasetPlan	Resource
`user_add` User add	Boolean	If true, the user can add this plan to a dataset
`user_remove` User remove	Boolean	If true, the user can remove this plan from a dataset