GetBlueprintDocumentation: Get documentation for tasks used in the blueprint

Description Usage Arguments Value Examples

View source: R/Blueprints.R

Description

Get documentation for tasks used in the blueprint

Usage

1
GetBlueprintDocumentation(project, blueprintId)

Arguments

project

character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

blueprintId

character. Id of blueprint to retrieve.

Value

list with following components

task

Character string name of the task described in document

description

Character string task description

title

Character string title of document

parameters

List of parameters that task can received in human-readable format with following components: name, type, description

links

List of external lines used in document with following components: name, url

references

List of references used in document with following components: name, url

Examples

1
2
3
4
5
6
7
8
## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  blueprintId <- model$blueprintId
  GetBlueprintDocumentation(projectId, blueprintId)

## End(Not run)

datarobot documentation built on June 2, 2021, 9:06 a.m.