projects
POST /projects.create
Description
Create a new project
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
default_output_destination optional | The default output destination URL for new tasks under this project | string |
description optional | Project description. | string |
name required | Project name Unique within the company. | string |
system_tags optional | System tags. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
id optional | Project id | string |
POST /projects.delete
Description
Deletes a project
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
delete_contents optional | If set to 'true' then the project tasks and models will be deleted. Otherwise their project property will be unassigned. Default value is 'false' | boolean |
delete_external_artifacts optional | If set to 'true' then BE will try to delete the extenal artifacts associated with the project tasks and models from the fileserver (if configured to do so) Default : true | boolean |
force optional | If not true, fails if project has tasks. If true, and project has tasks, they will be unassigned Default : false | boolean |
project required | Project ID | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
deleted optional | Number of projects deleted (0 or 1) | integer |
deleted_models optional | Number of models deleted | integer |
deleted_tasks optional | Number of tasks deleted | integer |
disassociated_tasks optional | Number of tasks disassociated from the deleted project | integer |
urls optional | The urls of the files that were uploaded by the project tasks and models. Returned if the 'delete_contents' was set to 'true' | projects.urls |
POST /projects.get_all
Description
Get all the company's projects and all public projects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
all optional | Multi-field pattern condition (all fields match pattern) | projects.multi_field_pattern_data |
any optional | Multi-field pattern condition (any field matches pattern) | projects.multi_field_pattern_data |
basename optional | Project base name | string |
description optional | Get only projects whose description matches this pattern (python regular expression syntax) | string |
id optional | List of IDs to filter by | < string > array |
name optional | Get only projects whose name matches this pattern (python regular expression syntax) | string |
only_fields optional | List of document's field names (nesting is supported using '.', e.g. execution.model_labels). If provided, this list defines the query's projection (only these fields will be returned for each result entry) | < string > array |
order_by optional | List of field names to order by. When search_text is used, '@text_score' can be used as a field representing the text score of returned documents. Use '-' prefix to specify descending order. Optional, recommended when using page | < string > array |
page optional | Page number, returns a specific page out of the resulting list of projects Minimum value : 0 | integer |
page_size optional | Page size, specifies the number of results returned in each page (last page may contain fewer results) Minimum value : 1 | integer |
refresh_scroll optional | If set then all the data received with this scroll will be requeried | boolean |
scroll_id optional | Scroll ID returned from the previos calls to get_all_ex | string |
search_hidden optional | If set to 'true' then hidden projects are included in the search results Default : false | boolean |
search_text optional | Free text search query | string |
shallow_search optional | If set to 'true' then the search with the specified criteria is performed among top level projects only (or if parents specified, among the direct children of the these parents). Otherwise the search is performed among all the company projects (or among all of the descendants of the specified parents). Default : false | boolean |
size optional | The number of projects to retrieve Minimum value : 1 | integer |
system_tags optional | System tags list used to filter results. Prepend '-' to system tag name to indicate exclusion | < string > array |
tags optional | User-defined tags list used to filter results. Prepend '-' to tag name to indicate exclusion | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
projects optional | Projects list | < projects.projects_get_all_response_single > array |
scroll_id optional | Scroll ID that can be used with the next calls to get_all_ex to retrieve more data | string |
POST /projects.get_all_ex
Description
Get all the company's projects and all public projects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
all optional | Multi-field pattern condition (all fields match pattern) | projects.multi_field_pattern_data |
any optional | Multi-field pattern condition (any field matches pattern) | projects.multi_field_pattern_data |
active_users optional | The list of users that were active in the project. If passes then the resulting projects are filtered to the ones that have tasks created by these users | < string > array |
allow_public optional | Allow public projects to be returned in the results Default : true | boolean |
basename optional | Project base name | string |
check_own_contents optional | If set to 'true' and project ids are passed to the query then for these projects their own tasks and models are counted Default : false | boolean |
children_tags optional | The list of tag values to filter children by. Takes effect only if children_type is set. Use 'null' value to specify empty tags. Use '__Snot' value to specify that the following value should be excluded | < string > array |
children_tags_filter optional | Filter on a field that includes combination of 'any' or 'all' included and excluded terms | children_tags_filter |
children_type optional | If specified that only the projects under which the entities of this type can be found will be returned | enum (pipeline, report, dataset) |
description optional | Get only projects whose description matches this pattern (python regular expression syntax) | string |
filters optional | < string, filters > map | |
id optional | List of IDs to filter by | < string > array |
include_dataset_stats optional | If true, include project dataset statistic in response Default : false | boolean |
include_stats optional | If true, include project statistic in response. Default : false | boolean |
include_stats_filter optional | The filter for selecting entities that participate in statistics calculation. For each task field that you want to filter on pass the list of allowed values. Prepend the value with '-' to exclude | object |
name optional | Get only projects whose name matches this pattern (python regular expression syntax) | string |
non_public optional | Return only non-public projects Default : false | boolean |
only_fields optional | List of document's field names (nesting is supported using '.', e.g. execution.model_labels). If provided, this list defines the query's projection (only these fields will be returned for each result entry) | < string > array |
order_by optional | List of field names to order by. When search_text is used, '@text_score' can be used as a field representing the text score of returned documents. Use '-' prefix to specify descending order. Optional, recommended when using page | < string > array |
page optional | Page number, returns a specific page out of the resulting list of projects Minimum value : 0 | integer |
page_size optional | Page size, specifies the number of results returned in each page (last page may contain fewer results) Minimum value : 1 | integer |
refresh_scroll optional | If set then all the data received with this scroll will be requeried | boolean |
scroll_id optional | Scroll ID returned from the previos calls to get_all | string |
search_hidden optional | If set to 'true' then hidden projects are included in the search results Default : false | boolean |
search_text optional | Free text search query | string |
shallow_search optional | If set to 'true' then the search with the specified criteria is performed among top level projects only (or if parents specified, among the direct children of the these parents). Otherwise the search is performed among all the company projects (or among all of the descendants of the specified parents). Default : false | boolean |
size optional | The number of projects to retrieve Minimum value : 1 | integer |
stats_for_state optional | Report stats include only statistics for tasks in the specified state. If Null is provided, stats for all task states will be returned. Default : "active" | enum (active, archived) |
stats_with_children optional | If include_stats flag is set then this flag contols whether the child projects tasks are taken into statistics or not Default : true | boolean |
system_tags optional | System tags list used to filter results. Prepend '-' to system tag name to indicate exclusion | < string > array |
tags optional | User-defined tags list used to filter results. Prepend '-' to tag name to indicate exclusion | < string > array |
children_tags_filter
Name | Description | Schema |
---|---|---|
all optional | All the terms in 'all' condition are combined with 'and' operation | all |
any optional | All the terms in 'any' condition are combined with 'or' operation | any |
op optional | The operation between 'any' and 'all' parts of the filter if both are provided Default : "and" | enum (and, or) |
all
Name | Schema |
---|---|
exclude optional | < string > array |
include optional | < string > array |
any
Name | Schema |
---|---|
exclude optional | < string > array |
include optional | < string > array |
filters
Name | Description | Schema |
---|---|---|
all optional | All the terms in 'all' condition are combined with 'and' operation | all |
any optional | All the terms in 'any' condition are combined with 'or' operation | any |
op optional | The operation between 'any' and 'all' parts of the filter if both are provided Default : "and" | enum (and, or) |
all
Name | Schema |
---|---|
exclude optional | < string > array |
include optional | < string > array |
any
Name | Schema |
---|---|
exclude optional | < string > array |
include optional | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
projects optional | Projects list | < projects.projects_get_all_response_single > array |
scroll_id optional | Scroll ID that can be used with the next calls to get_all to retrieve more data | string |
POST /projects.get_by_id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
project required | Project id | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
project optional | Project info | projects.project |
POST /projects.get_hyper_parameters
Description
Get a list of all hyper parameter sections and names used in tasks within the
given project.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
include_subprojects optional | If set to 'true' and the project field is set then the result includes hyper parameters from the subproject tasks Default : true | boolean |
page optional | Page number | integer |
page_size optional | Page size | integer |
project required | Project ID | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
parameters optional | A list of parameter sections and names | < object > array |
remaining optional | Remaining results | integer |
total optional | Total number of results | integer |
POST /projects.get_hyperparam_values
Description
Get a list of distinct values for the chosen hyperparameter
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
allow_public optional | If set to 'true' then collect values from both company and public tasks otherwise company tasks only. The default is 'true' | boolean |
include_subprojects optional | If set to 'true' and the project field is set then the result includes hyper parameters values from the subproject tasks Default : true | boolean |
name required | Hyperparameter name | string |
page optional | Page number | integer |
page_size optional | Page size | integer |
pattern optional | The search pattern regex | string |
projects optional | Project IDs | < string > array |
section required | Hyperparameter section name | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
total optional | Total number of distinct parameter values | integer |
values optional | The list of the unique values for the parameter | < string > array |
POST /projects.get_model_metadata_keys
Description
Get a list of all metadata keys used in models within the given project.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
include_subprojects optional | If set to 'true' and the project field is set then the result includes metadate keys from the subproject models Default : true | boolean |
page optional | Page number | integer |
page_size optional | Page size | integer |
project required | Project ID | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
keys optional | A list of model keys | < string > array |
remaining optional | Remaining results | integer |
total optional | Total number of results | integer |
POST /projects.get_model_metadata_values
Description
Get a list of distinct values for the chosen model metadata key
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
allow_public optional | If set to 'true' then collect values from both company and public models otherwise company modeels only. The default is 'true' | boolean |
include_subprojects optional | If set to 'true' and the project field is set then the result includes metadata values from the subproject models Default : true | boolean |
key required | Metadata key | string |
page optional | Page number | integer |
page_size optional | Page size | integer |
projects optional | Project IDs | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
total optional | Total number of distinct values | integer |
values optional | The list of the unique values | < string > array |
POST /projects.get_model_tags
Description
Get user and system tags used for the models under the specified projects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
filter optional | Filter on entities to collect tags from | filter |
include_system optional | If set to 'true' then the list of the system tags is also returned. The default value is 'false' Default : false | boolean |
projects optional | The list of projects under which the tags are searched. If not passed or empty then all the projects are searched | < string > array |
filter
Name | Description | Schema |
---|---|---|
system_tags optional | The list of system tag values to filter by. Use 'null' value to specify empty system tags. Use '__Snot' value to specify that the following value should be excluded | < string > array |
tags optional | The list of tag values to filter by. Use 'null' value to specify empty tags. Use '__Snot' value to specify that the following value should be excluded | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
system_tags optional | The list of unique system tag values. Returned only if 'include_system' is set to 'true' in the request | < string > array |
tags optional | The list of unique tag values | < string > array |
POST /projects.get_project_tags
Description
Get user and system tags used for the specified projects and their children
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
filter optional | Filter on entities to collect tags from | filter |
include_system optional | If set to 'true' then the list of the system tags is also returned. The default value is 'false' Default : false | boolean |
projects optional | The list of projects under which the tags are searched. If not passed or empty then all the projects are searched | < string > array |
filter
Name | Description | Schema |
---|---|---|
system_tags optional | The list of system tag values to filter by. Use 'null' value to specify empty system tags. Use '__Snot' value to specify that the following value should be excluded | < string > array |
tags optional | The list of tag values to filter by. Use 'null' value to specify empty tags. Use '__Snot' value to specify that the following value should be excluded | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
system_tags optional | The list of unique system tag values. Returned only if 'include_system' is set to 'true' in the request | < string > array |
tags optional | The list of unique tag values | < string > array |
POST /projects.get_task_parents
Description
Get unique parent tasks for the tasks in the specified projects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
include_subprojects optional | If set to 'true' and the projects field is not empty then the result includes tasks parents from the subproject tasks Default : true | boolean |
projects optional | The list of projects which task parents are retieved. If not passed or empty then all the projects are searched | < string > array |
task_name optional | Task name pattern for the returned parent tasks | string |
tasks_state optional | Return parents for tasks in the specified state. If Null is provided, parents for all task states will be returned. Default : "active" | enum (active, archived) |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
parents optional | The list of unique task parents sorted by their names | < parents > array |
parents
Name | Description | Schema |
---|---|---|
id optional | The ID of the parent task | string |
name optional | The name of the parent task | string |
project optional | project |
project
Name | Description | Schema |
---|---|---|
id optional | The ID of the parent task project | string |
name optional | The name of the parent task project | string |
POST /projects.get_task_tags
Description
Get user and system tags used for the tasks under the specified projects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
filter optional | Filter on entities to collect tags from | filter |
include_system optional | If set to 'true' then the list of the system tags is also returned. The default value is 'false' Default : false | boolean |
projects optional | The list of projects under which the tags are searched. If not passed or empty then all the projects are searched | < string > array |
filter
Name | Description | Schema |
---|---|---|
system_tags optional | The list of system tag values to filter by. Use 'null' value to specify empty system tags. Use '__Snot' value to specify that the following value should be excluded | < string > array |
tags optional | The list of tag values to filter by. Use 'null' value to specify empty tags. Use '__Snot' value to specify that the following value should be excluded | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
system_tags optional | The list of unique system tag values. Returned only if 'include_system' is set to 'true' in the request | < string > array |
tags optional | The list of unique tag values | < string > array |
POST /projects.get_unique_metric_variants
Description
Get all metric/variant pairs reported for tasks in a specific project. If no
project is specified, metrics/variant paris reported for all tasks will be
returned. If the project does not exist, an empty list will be returned.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
ids optional | IDs of the tasks or models to get metrics from | < string > array |
include_subprojects optional | If set to 'true' and the project field is set then the result includes metrics/variants from the subproject tasks Default : true | boolean |
model_metrics optional | If set to Truethen bring unique metric and variant names from the project models otherwise from the project tasks Default : false | boolean |
project optional | Project ID | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
metrics optional | A list of metric variants reported for tasks in this project | < projects.metric_variant_result > array |
POST /projects.get_user_names
Description
Get names and ids of the users who created child entitites under the passed
projects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
entity optional | The type of the child entity to look for Default : "task" | enum (task, model) |
include_subprojects optional | If set to 'true' and the projects field is not empty then the result includes user name from the subprojects children Default : true | boolean |
projects optional | The list of projects. If not passed or empty then all the projects are searched | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
users optional | The list of users sorted by their names | < users > array |
users
Name | Description | Schema |
---|---|---|
id optional | The ID of the user | string |
name optional | The name of the user | string |
POST /projects.make_private
Description
Convert public projects to private
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
ids optional | Ids of the projects to convert. Only the projects originated by the company can be converted | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
updated optional | Number of projects updated | integer |
POST /projects.make_public
Description
Convert company projects to public
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
ids optional | Ids of the projects to convert | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
updated optional | Number of projects updated | integer |
POST /projects.merge
Description
Moves all the source project's contents to the destination project and remove
the source project
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
destination_project optional | The ID of the destination project | string |
project required | Project id | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
moved_entities optional | The number of tasks and models moved from the merged project into the destination | integer |
moved_projects optional | The number of child projects moved from the merged project into the destination | integer |
POST /projects.move
Description
Moves a project and all of its subprojects under the different location
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
new_location optional | The name location for the project | string |
project required | Project id | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
moved optional | The number of projects moved | integer |
POST /projects.update
Description
Update project information
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
default_output_destination optional | The default output destination URL for new tasks under this project | string |
description optional | Project description | string |
name optional | Project name. Unique within the company. | string |
project required | Project id | string |
system_tags optional | System tags list. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags list | < string > array |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
fields optional | Updated fields names and values | object |
updated optional | Number of projects updated (0 or 1) | integer |
POST /projects.validate_delete
Description
Validates that the project existis and can be deleted
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request required | request body | request |
request
Name | Description | Schema |
---|---|---|
project required | Project ID | string |
Responses
HTTP Code | Schema |
---|---|
200 | Response 200 |
Response 200
Name | Description | Schema |
---|---|---|
datasets optional | The total number of non-empty datasets under the project and all its children | integer |
models optional | The total number of models under the project and all its children | integer |
non_archived_models optional | The total number of non-archived models under the project and all its children | integer |
non_archived_reports optional | The total number of non-archived reports under the project and all its children | integer |
non_archived_tasks optional | The total number of non-archived tasks under the project and all its children | integer |
pipelines optional | The total number of pipelines with active controllers under the project and all its children | integer |
reports optional | The total number of reports under the project and all its children | integer |
tasks optional | The total number of tasks under the project and all its children | integer |