diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de3fc9d..60d5922 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -171,7 +171,7 @@ func (c CreateCommand) Execute(context plugin.ExecutionContext, writer output.Ou ```go func (c CreateCommand) Command() plugin.Command { return *plugin.NewCommand("myservice"). - WithOperation("create-product", "Creates a product"). + WithOperation("create-product", "Create product", "Creates a new product in the store"). WithParameter("id", plugin.ParameterTypeInteger, "The product id", true). WithParameter("name", plugin.ParameterTypeString, "The product name", true). WithParameter("description", plugin.ParameterTypeString, "The product description", false) diff --git a/commandline/command_builder.go b/commandline/command_builder.go index 8b85782..9bbd149 100644 --- a/commandline/command_builder.go +++ b/commandline/command_builder.go @@ -498,6 +498,7 @@ func (b CommandBuilder) execute(executionContext executor.ExecutionContext, outp func (b CommandBuilder) createCategoryCommand(operation parser.Operation) *cli.Command { return &cli.Command{ Name: operation.Category.Name, + Usage: operation.Category.Summary, Description: operation.Category.Description, Flags: []cli.Flag{ b.HelpFlag(), @@ -541,6 +542,7 @@ func (b CommandBuilder) createServiceCommand(definition parser.Definition) *cli. return &cli.Command{ Name: definition.Name, + Usage: definition.Summary, Description: definition.Description, Flags: []cli.Flag{ b.HelpFlag(), @@ -559,6 +561,7 @@ func (b CommandBuilder) createAutoCompleteEnableCommand() *cli.Command { return &cli.Command{ Name: "enable", + Usage: "Enable auto complete", Description: "Enables auto complete in your shell", Flags: []cli.Flag{ &cli.StringFlag{ @@ -590,6 +593,7 @@ func (b CommandBuilder) createAutoCompleteEnableCommand() *cli.Command { func (b CommandBuilder) createAutoCompleteCompleteCommand(version string) *cli.Command { return &cli.Command{ Name: "complete", + Usage: "Autocomplete suggestions", Description: "Returns the autocomplete suggestions", Flags: []cli.Flag{ &cli.StringFlag{ @@ -625,6 +629,7 @@ func (b CommandBuilder) createAutoCompleteCompleteCommand(version string) *cli.C func (b CommandBuilder) createAutoCompleteCommand(version string) *cli.Command { return &cli.Command{ Name: "autocomplete", + Usage: "Autocompletion", Description: "Commands for autocompletion", Flags: []cli.Flag{ b.HelpFlag(), @@ -655,6 +660,7 @@ func (b CommandBuilder) createConfigCommand() *cli.Command { return &cli.Command{ Name: "config", + Usage: "Interactive Configuration", Description: "Interactive command to configure the CLI", Flags: flags, Subcommands: []*cli.Command{ @@ -663,11 +669,7 @@ func (b CommandBuilder) createConfigCommand() *cli.Command { Action: func(context *cli.Context) error { auth := context.String(authFlagName) profileName := context.String(profileFlagName) - handler := ConfigCommandHandler{ - StdIn: b.StdIn, - StdOut: b.StdOut, - ConfigProvider: b.ConfigProvider, - } + handler := newConfigCommandHandler(b.StdIn, b.StdOut, b.ConfigProvider) return handler.Configure(auth, profileName) }, HideHelp: true, @@ -698,17 +700,14 @@ func (b CommandBuilder) createConfigSetCommand() *cli.Command { } return &cli.Command{ Name: "set", + Usage: "Set config parameters", Description: "Set config parameters", Flags: flags, Action: func(context *cli.Context) error { profileName := context.String(profileFlagName) key := context.String(keyFlagName) value := context.String(valueFlagName) - handler := ConfigCommandHandler{ - StdIn: b.StdIn, - StdOut: b.StdOut, - ConfigProvider: b.ConfigProvider, - } + handler := newConfigCommandHandler(b.StdIn, b.StdOut, b.ConfigProvider) return handler.Set(key, value, profileName) }, HideHelp: true, @@ -754,9 +753,10 @@ func (b CommandBuilder) loadAutocompleteDefinitions(args []string, version strin return b.loadDefinitions(args, version) } -func (b CommandBuilder) createShowCommand(definitions []parser.Definition, commands []*cli.Command) *cli.Command { +func (b CommandBuilder) createShowCommand(definitions []parser.Definition) *cli.Command { return &cli.Command{ Name: "commands", + Usage: "Inspect available CLI operations", Description: "Command to inspect available uipath CLI operations", Flags: []cli.Flag{ b.HelpFlag(), @@ -764,6 +764,7 @@ func (b CommandBuilder) createShowCommand(definitions []parser.Definition, comma Subcommands: []*cli.Command{ { Name: "show", + Usage: "Print CLI commands", Description: "Print available uipath CLI commands", Flags: []cli.Flag{ b.HelpFlag(), @@ -832,7 +833,7 @@ func (b CommandBuilder) Create(args []string) ([]*cli.Command, error) { servicesCommands := b.createServiceCommands(definitions) autocompleteCommand := b.createAutoCompleteCommand(version) configCommand := b.createConfigCommand() - showCommand := b.createShowCommand(definitions, servicesCommands) + showCommand := b.createShowCommand(definitions) commands := append(servicesCommands, autocompleteCommand, configCommand, showCommand) return commands, nil } diff --git a/commandline/config_command_handler.go b/commandline/config_command_handler.go index 79e808e..6fc1a77 100644 --- a/commandline/config_command_handler.go +++ b/commandline/config_command_handler.go @@ -9,14 +9,14 @@ import ( "github.com/UiPath/uipathcli/config" ) -// The ConfigCommandHandler implements commands for configuring the CLI. +// configCommandHandler implements commands for configuring the CLI. // The CLI can be configured interactively or by setting config values // programmatically. // // Example: // uipath config ==> interactive configuration of the CLI // uipath config set ==> stores a value in the configuration file -type ConfigCommandHandler struct { +type configCommandHandler struct { StdIn io.Reader StdOut io.Writer ConfigProvider config.ConfigProvider @@ -31,7 +31,7 @@ const CredentialsAuth = "credentials" const LoginAuth = "login" const PatAuth = "pat" -func (h ConfigCommandHandler) Set(key string, value string, profileName string) error { +func (h configCommandHandler) Set(key string, value string, profileName string) error { config := h.getOrCreateProfile(profileName) err := h.setConfigValue(&config, key, value) if err != nil { @@ -45,7 +45,7 @@ func (h ConfigCommandHandler) Set(key string, value string, profileName string) return nil } -func (h ConfigCommandHandler) setConfigValue(config *config.Config, key string, value string) error { +func (h configCommandHandler) setConfigValue(config *config.Config, key string, value string) error { keyParts := strings.Split(key, ".") if key == "version" { config.SetVersion(value) @@ -91,19 +91,19 @@ func (h ConfigCommandHandler) setConfigValue(config *config.Config, key string, return fmt.Errorf("Unknown config key '%s'", key) } -func (h ConfigCommandHandler) isHeaderKey(keyParts []string) bool { +func (h configCommandHandler) isHeaderKey(keyParts []string) bool { return len(keyParts) == 2 && keyParts[0] == "header" } -func (h ConfigCommandHandler) isParameterKey(keyParts []string) bool { +func (h configCommandHandler) isParameterKey(keyParts []string) bool { return len(keyParts) == 2 && keyParts[0] == "parameter" } -func (h ConfigCommandHandler) isAuthPropertyKey(keyParts []string) bool { +func (h configCommandHandler) isAuthPropertyKey(keyParts []string) bool { return len(keyParts) == 3 && keyParts[0] == "auth" && keyParts[1] == "properties" } -func (h ConfigCommandHandler) convertToBool(value string) (bool, error) { +func (h configCommandHandler) convertToBool(value string) (bool, error) { if strings.EqualFold(value, "true") { return true, nil } @@ -113,7 +113,7 @@ func (h ConfigCommandHandler) convertToBool(value string) (bool, error) { return false, fmt.Errorf("Invalid boolean value: %s", value) } -func (h ConfigCommandHandler) Configure(auth string, profileName string) error { +func (h configCommandHandler) Configure(auth string, profileName string) error { switch auth { case CredentialsAuth: return h.configureCredentials(profileName) @@ -127,7 +127,7 @@ func (h ConfigCommandHandler) Configure(auth string, profileName string) error { return fmt.Errorf("Invalid auth, supported values: %s, %s, %s", CredentialsAuth, LoginAuth, PatAuth) } -func (h ConfigCommandHandler) configure(profileName string) error { +func (h configCommandHandler) configure(profileName string) error { config := h.getOrCreateProfile(profileName) reader := bufio.NewReader(h.StdIn) @@ -149,7 +149,7 @@ func (h ConfigCommandHandler) configure(profileName string) error { return nil } -func (h ConfigCommandHandler) readAuthInput(config config.Config, reader *bufio.Reader) bool { +func (h configCommandHandler) readAuthInput(config config.Config, reader *bufio.Reader) bool { authType := h.readAuthTypeInput(config, reader) switch authType { case CredentialsAuth: @@ -175,7 +175,7 @@ func (h ConfigCommandHandler) readAuthInput(config config.Config, reader *bufio. } } -func (h ConfigCommandHandler) configureCredentials(profileName string) error { +func (h configCommandHandler) configureCredentials(profileName string) error { config := h.getOrCreateProfile(profileName) reader := bufio.NewReader(h.StdIn) @@ -201,7 +201,7 @@ func (h ConfigCommandHandler) configureCredentials(profileName string) error { return nil } -func (h ConfigCommandHandler) configureLogin(profileName string) error { +func (h configCommandHandler) configureLogin(profileName string) error { config := h.getOrCreateProfile(profileName) reader := bufio.NewReader(h.StdIn) @@ -227,7 +227,7 @@ func (h ConfigCommandHandler) configureLogin(profileName string) error { return nil } -func (h ConfigCommandHandler) configurePat(profileName string) error { +func (h configCommandHandler) configurePat(profileName string) error { config := h.getOrCreateProfile(profileName) reader := bufio.NewReader(h.StdIn) @@ -253,7 +253,7 @@ func (h ConfigCommandHandler) configurePat(profileName string) error { return nil } -func (h ConfigCommandHandler) getAuthType(config config.Config) string { +func (h configCommandHandler) getAuthType(config config.Config) string { if config.Pat() != "" { return PatAuth } @@ -266,7 +266,7 @@ func (h ConfigCommandHandler) getAuthType(config config.Config) string { return "" } -func (h ConfigCommandHandler) getOrCreateProfile(profileName string) config.Config { +func (h configCommandHandler) getOrCreateProfile(profileName string) config.Config { config := h.ConfigProvider.Config(profileName) if config == nil { return h.ConfigProvider.New() @@ -274,7 +274,7 @@ func (h ConfigCommandHandler) getOrCreateProfile(profileName string) config.Conf return *config } -func (h ConfigCommandHandler) getDisplayValue(value string, masked bool) string { +func (h configCommandHandler) getDisplayValue(value string, masked bool) string { if value == "" { return notSetMessage } @@ -284,14 +284,14 @@ func (h ConfigCommandHandler) getDisplayValue(value string, masked bool) string return value } -func (h ConfigCommandHandler) maskValue(value string) string { +func (h configCommandHandler) maskValue(value string) string { if len(value) < 10 { return maskMessage } return maskMessage + value[len(value)-4:] } -func (h ConfigCommandHandler) readUserInput(message string, reader *bufio.Reader) (string, error) { +func (h configCommandHandler) readUserInput(message string, reader *bufio.Reader) (string, error) { fmt.Fprint(h.StdOut, message+" ") value, err := reader.ReadString('\n') if err != nil { @@ -300,7 +300,7 @@ func (h ConfigCommandHandler) readUserInput(message string, reader *bufio.Reader return strings.Trim(value, " \r\n\t"), nil } -func (h ConfigCommandHandler) readOrgTenantInput(config config.Config, reader *bufio.Reader) (string, string, error) { +func (h configCommandHandler) readOrgTenantInput(config config.Config, reader *bufio.Reader) (string, string, error) { message := fmt.Sprintf("Enter organization [%s]:", h.getDisplayValue(config.Organization, false)) organization, err := h.readUserInput(message, reader) if err != nil { @@ -316,7 +316,7 @@ func (h ConfigCommandHandler) readOrgTenantInput(config config.Config, reader *b return organization, tenant, nil } -func (h ConfigCommandHandler) readCredentialsInput(config config.Config, reader *bufio.Reader) (string, string, error) { +func (h configCommandHandler) readCredentialsInput(config config.Config, reader *bufio.Reader) (string, string, error) { message := fmt.Sprintf("Enter client id [%s]:", h.getDisplayValue(config.ClientId(), true)) clientId, err := h.readUserInput(message, reader) if err != nil { @@ -332,7 +332,7 @@ func (h ConfigCommandHandler) readCredentialsInput(config config.Config, reader return clientId, clientSecret, nil } -func (h ConfigCommandHandler) readLoginInput(config config.Config, reader *bufio.Reader) (string, string, string, error) { +func (h configCommandHandler) readLoginInput(config config.Config, reader *bufio.Reader) (string, string, string, error) { message := fmt.Sprintf("Enter client id [%s]:", h.getDisplayValue(config.ClientId(), true)) clientId, err := h.readUserInput(message, reader) if err != nil { @@ -352,12 +352,12 @@ func (h ConfigCommandHandler) readLoginInput(config config.Config, reader *bufio return clientId, redirectUri, scopes, nil } -func (h ConfigCommandHandler) readPatInput(config config.Config, reader *bufio.Reader) (string, error) { +func (h configCommandHandler) readPatInput(config config.Config, reader *bufio.Reader) (string, error) { message := fmt.Sprintf("Enter personal access token [%s]:", h.getDisplayValue(config.Pat(), true)) return h.readUserInput(message, reader) } -func (h ConfigCommandHandler) readAuthTypeInput(config config.Config, reader *bufio.Reader) string { +func (h configCommandHandler) readAuthTypeInput(config config.Config, reader *bufio.Reader) string { authType := h.getAuthType(config) for { message := fmt.Sprintf(`Authentication type [%s]: @@ -381,3 +381,11 @@ Select:`, h.getDisplayValue(authType, false)) } } } + +func newConfigCommandHandler(stdIn io.Reader, stdOut io.Writer, configProvider config.ConfigProvider) *configCommandHandler { + return &configCommandHandler{ + StdIn: stdIn, + StdOut: stdOut, + ConfigProvider: configProvider, + } +} diff --git a/commandline/definition_provider.go b/commandline/definition_provider.go index aa36cd6..bfcb243 100644 --- a/commandline/definition_provider.go +++ b/commandline/definition_provider.go @@ -122,7 +122,7 @@ func (p DefinitionProvider) applyPluginCommand(plugin plugin.CommandPlugin, comm parameters := p.convertToParameters(command.Parameters) var category *parser.OperationCategory if command.Category != nil { - category = parser.NewOperationCategory(command.Category.Name, command.Category.Description) + category = parser.NewOperationCategory(command.Category.Name, command.Category.Summary, command.Category.Description) } baseUri, _ := url.Parse(parser.DefaultServerBaseUrl) operation := parser.NewOperation(command.Name, command.Description, "", "", *baseUri, "", "application/json", parameters, plugin, command.Hidden, category) diff --git a/commandline/multi_definition.go b/commandline/multi_definition.go index f521b67..0fb6295 100644 --- a/commandline/multi_definition.go +++ b/commandline/multi_definition.go @@ -16,7 +16,7 @@ func (d multiDefinition) Merge(name string, definitions []*parser.Definition) *p operations := []parser.Operation{} for _, definition := range definitions { for _, operation := range definition.Operations { - category := d.getCategory(operation, definition) + category := d.getCategory(operation) operations = append(operations, *parser.NewOperation(operation.Name, operation.Summary, operation.Description, @@ -30,14 +30,14 @@ func (d multiDefinition) Merge(name string, definitions []*parser.Definition) *p category)) } } - return parser.NewDefinition(name, definitions[0].Description, operations) + return parser.NewDefinition(name, definitions[0].Summary, definitions[0].Description, operations) } -func (d multiDefinition) getCategory(operation parser.Operation, definition *parser.Definition) *parser.OperationCategory { - if operation.Category == nil || operation.Category.Description != "" { +func (d multiDefinition) getCategory(operation parser.Operation) *parser.OperationCategory { + if operation.Category == nil || operation.Category.Summary != "" || operation.Category.Description != "" { return operation.Category } - return parser.NewOperationCategory(operation.Category.Name, definition.Description) + return parser.NewOperationCategory(operation.Category.Name, operation.Category.Summary, operation.Category.Description) } func newMultiDefinition() *multiDefinition { diff --git a/definitions/du.framework.yaml b/definitions/du.framework.yaml index 320b741..d860fa0 100644 --- a/definitions/du.framework.yaml +++ b/definitions/du.framework.yaml @@ -8,7 +8,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve all projects description: "Retrieve all available projects from Document Understanding.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetProjects parameters: @@ -86,7 +86,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve project details description: "Retrieve details about a specific project from Document Understanding.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetProjectById parameters: @@ -174,7 +174,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve document types description: "Retrieve all document types from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetDocumentTypes parameters: @@ -271,7 +271,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve document type details description: "Retrieve details about a specific document type from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetDocumentTypeById parameters: @@ -378,7 +378,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve classifiers description: "Retrieve all classifiers from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetClassifiers parameters: @@ -478,7 +478,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve classifier details description: "Retrieve details about a specific classifier from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetClassifierById parameters: @@ -582,7 +582,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve extractors description: "Retrieve all extractors from a project. These can be either Forms AI or deep-learning extraction skills.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: Extractors parameters: @@ -682,7 +682,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve extractor details description: "Retrieve details about a specific extractor from a project. It can be either a Forms AI or a deep-learning extraction skill.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetExtractorById parameters: @@ -798,7 +798,7 @@ paths: get: tags: - Discovery - summary: "" + summary: Retrieve tags description: "Retrieve all tags from a project. \r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: Tags parameters: @@ -895,7 +895,7 @@ paths: post: tags: - Digitization - summary: "" + summary: Digitize document description: "Digitize a document using the OCR settings of the associated Document Understanding project.\r\n\nRequired scopes: Du.Digitization.Api
" operationId: StartDigitization parameters: @@ -1031,7 +1031,7 @@ paths: get: tags: - Digitization - summary: "" + summary: Get digitization result description: "Get the digitization result of a document.\r\n\nRequired scopes: Du.Digitization.Api
" operationId: GetDigitizationResult parameters: @@ -1144,7 +1144,7 @@ paths: post: tags: - Classification - summary: "" + summary: Classify document description: "Classify a document.\r\n\nRequired scopes: Du.Classification.Api
" operationId: Classify parameters: @@ -1178,11 +1178,11 @@ paths: examples: Specialized Classification: value: - documentId: df258d93-3482-4d73-93ae-3825f502a2e9 + documentId: 01d7210a-c33f-4688-91c0-3807a63b0833 prompts: null Generative Classification: value: - documentId: df258d93-3482-4d73-93ae-3825f502a2e9 + documentId: 01d7210a-c33f-4688-91c0-3807a63b0833 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1194,11 +1194,11 @@ paths: examples: Specialized Classification: value: - documentId: df258d93-3482-4d73-93ae-3825f502a2e9 + documentId: 01d7210a-c33f-4688-91c0-3807a63b0833 prompts: null Generative Classification: value: - documentId: df258d93-3482-4d73-93ae-3825f502a2e9 + documentId: 01d7210a-c33f-4688-91c0-3807a63b0833 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1210,11 +1210,11 @@ paths: examples: Specialized Classification: value: - documentId: df258d93-3482-4d73-93ae-3825f502a2e9 + documentId: 01d7210a-c33f-4688-91c0-3807a63b0833 prompts: null Generative Classification: value: - documentId: df258d93-3482-4d73-93ae-3825f502a2e9 + documentId: 01d7210a-c33f-4688-91c0-3807a63b0833 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1310,7 +1310,7 @@ paths: post: tags: - Classification - summary: "" + summary: Classify document description: "Classify a document.\r\n\nRequired scopes: Du.Classification.Api
" operationId: ClassifyByTag parameters: @@ -1341,11 +1341,11 @@ paths: examples: Specialized Classification: value: - documentId: f4587412-1535-4f3c-9da1-018584f63696 + documentId: 3d81558b-81b2-4978-9291-4a65b4af8442 prompts: null Generative Classification: value: - documentId: f4587412-1535-4f3c-9da1-018584f63696 + documentId: 3d81558b-81b2-4978-9291-4a65b4af8442 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1357,11 +1357,11 @@ paths: examples: Specialized Classification: value: - documentId: f4587412-1535-4f3c-9da1-018584f63696 + documentId: 3d81558b-81b2-4978-9291-4a65b4af8442 prompts: null Generative Classification: value: - documentId: f4587412-1535-4f3c-9da1-018584f63696 + documentId: 3d81558b-81b2-4978-9291-4a65b4af8442 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1373,11 +1373,11 @@ paths: examples: Specialized Classification: value: - documentId: f4587412-1535-4f3c-9da1-018584f63696 + documentId: 3d81558b-81b2-4978-9291-4a65b4af8442 prompts: null Generative Classification: value: - documentId: f4587412-1535-4f3c-9da1-018584f63696 + documentId: 3d81558b-81b2-4978-9291-4a65b4af8442 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1473,7 +1473,7 @@ paths: post: tags: - Classification - summary: "" + summary: Start classification description: "Start classification operation. To monitor the status and retrieve the classification result, use the \"Get Classification Result\" route.\r\n\nRequired scopes: Du.Classification.Api
" operationId: StartClassification parameters: @@ -1507,11 +1507,11 @@ paths: examples: Specialized Classification: value: - documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + documentId: 1de31e53-5f68-4e16-a1ac-9831ba324821 prompts: null Generative Classification: value: - documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + documentId: 1de31e53-5f68-4e16-a1ac-9831ba324821 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1523,11 +1523,11 @@ paths: examples: Specialized Classification: value: - documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + documentId: 1de31e53-5f68-4e16-a1ac-9831ba324821 prompts: null Generative Classification: value: - documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + documentId: 1de31e53-5f68-4e16-a1ac-9831ba324821 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1539,11 +1539,11 @@ paths: examples: Specialized Classification: value: - documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + documentId: 1de31e53-5f68-4e16-a1ac-9831ba324821 prompts: null Generative Classification: value: - documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + documentId: 1de31e53-5f68-4e16-a1ac-9831ba324821 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1615,7 +1615,7 @@ paths: post: tags: - Classification - summary: "" + summary: Start classification by tag description: "Start classification by tag operation. To monitor the status and retrieve the classification result, use the \"Get Tag Classification Result\" route.\r\n\nRequired scopes: Du.Classification.Api
" operationId: StartClassificationByTag parameters: @@ -1646,11 +1646,11 @@ paths: examples: Specialized Classification: value: - documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + documentId: b6f3bb35-677d-44e4-8f76-0cd1f313b9b2 prompts: null Generative Classification: value: - documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + documentId: b6f3bb35-677d-44e4-8f76-0cd1f313b9b2 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1662,11 +1662,11 @@ paths: examples: Specialized Classification: value: - documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + documentId: b6f3bb35-677d-44e4-8f76-0cd1f313b9b2 prompts: null Generative Classification: value: - documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + documentId: b6f3bb35-677d-44e4-8f76-0cd1f313b9b2 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1678,11 +1678,11 @@ paths: examples: Specialized Classification: value: - documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + documentId: b6f3bb35-677d-44e4-8f76-0cd1f313b9b2 prompts: null Generative Classification: value: - documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + documentId: b6f3bb35-677d-44e4-8f76-0cd1f313b9b2 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1754,7 +1754,7 @@ paths: get: tags: - Classification - summary: "" + summary: Retrieve classification result description: "Monitor the status and retrieve the classification result once the operation is completed.\r\n\nRequired scopes: Du.Classification.Api
" operationId: GetClassificationResult parameters: @@ -1862,7 +1862,7 @@ paths: get: tags: - Classification - summary: "" + summary: Retrieve classification result description: "Monitor the status and retrieve the classification result once the operation is completed.\r\n\nRequired scopes: Du.Classification.Api
" operationId: GetClassificationResultByTag parameters: @@ -1967,7 +1967,7 @@ paths: post: tags: - Extraction - summary: "" + summary: Extract document fields description: "Extract all fields from a document.\r\n\nRequired scopes: Du.Extraction.Api
" operationId: Extract parameters: @@ -2001,13 +2001,13 @@ paths: examples: Specialized Extraction: value: - documentId: d1925eb0-1431-4521-96f9-5996818ff52e + documentId: 71c8db12-83ba-4ac2-9063-c5d8cd72c8e9 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: d1925eb0-1431-4521-96f9-5996818ff52e + documentId: 71c8db12-83ba-4ac2-9063-c5d8cd72c8e9 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2022,13 +2022,13 @@ paths: examples: Specialized Extraction: value: - documentId: d1925eb0-1431-4521-96f9-5996818ff52e + documentId: 71c8db12-83ba-4ac2-9063-c5d8cd72c8e9 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: d1925eb0-1431-4521-96f9-5996818ff52e + documentId: 71c8db12-83ba-4ac2-9063-c5d8cd72c8e9 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2043,13 +2043,13 @@ paths: examples: Specialized Extraction: value: - documentId: d1925eb0-1431-4521-96f9-5996818ff52e + documentId: 71c8db12-83ba-4ac2-9063-c5d8cd72c8e9 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: d1925eb0-1431-4521-96f9-5996818ff52e + documentId: 71c8db12-83ba-4ac2-9063-c5d8cd72c8e9 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2160,7 +2160,7 @@ paths: post: tags: - Extraction - summary: "" + summary: Start extraction description: "Start extraction operation. To monitor the status and retrieve the extraction result, use the \"Get Extraction Result\" route.\r\n\nRequired scopes: Du.Extraction.Api
" operationId: StartExtraction parameters: @@ -2194,13 +2194,13 @@ paths: examples: Specialized Extraction: value: - documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + documentId: 9ecbf874-62a5-4c8c-bdc2-16f60de52c24 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + documentId: 9ecbf874-62a5-4c8c-bdc2-16f60de52c24 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2215,13 +2215,13 @@ paths: examples: Specialized Extraction: value: - documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + documentId: 9ecbf874-62a5-4c8c-bdc2-16f60de52c24 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + documentId: 9ecbf874-62a5-4c8c-bdc2-16f60de52c24 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2236,13 +2236,13 @@ paths: examples: Specialized Extraction: value: - documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + documentId: 9ecbf874-62a5-4c8c-bdc2-16f60de52c24 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + documentId: 9ecbf874-62a5-4c8c-bdc2-16f60de52c24 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2317,7 +2317,7 @@ paths: post: tags: - Extraction - summary: "" + summary: Start extraction description: "Start extraction operation. To monitor the status and retrieve the extraction result, use the \"Get Extraction Result\" route.\r\n\nRequired scopes: Du.Extraction.Api
" operationId: ExtractByDocumentType parameters: @@ -2352,13 +2352,13 @@ paths: examples: Specialized Extraction: value: - documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + documentId: e001ad91-5f30-44ad-9eed-a50b5bae1d86 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + documentId: e001ad91-5f30-44ad-9eed-a50b5bae1d86 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2373,13 +2373,13 @@ paths: examples: Specialized Extraction: value: - documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + documentId: e001ad91-5f30-44ad-9eed-a50b5bae1d86 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + documentId: e001ad91-5f30-44ad-9eed-a50b5bae1d86 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2394,13 +2394,13 @@ paths: examples: Specialized Extraction: value: - documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + documentId: e001ad91-5f30-44ad-9eed-a50b5bae1d86 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + documentId: e001ad91-5f30-44ad-9eed-a50b5bae1d86 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2511,7 +2511,7 @@ paths: post: tags: - Extraction - summary: "" + summary: Start extraction description: "Start extraction operation. To monitor the status and retrieve the extraction result, use the \"Get Extraction Result\" route.\r\n\nRequired scopes: Du.Extraction.Api
" operationId: StartByDocumentType parameters: @@ -2546,13 +2546,13 @@ paths: examples: Specialized Extraction: value: - documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + documentId: 7d38d17f-978f-4089-b086-02982bbb5fd9 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + documentId: 7d38d17f-978f-4089-b086-02982bbb5fd9 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2567,13 +2567,13 @@ paths: examples: Specialized Extraction: value: - documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + documentId: 7d38d17f-978f-4089-b086-02982bbb5fd9 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + documentId: 7d38d17f-978f-4089-b086-02982bbb5fd9 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2588,13 +2588,13 @@ paths: examples: Specialized Extraction: value: - documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + documentId: 7d38d17f-978f-4089-b086-02982bbb5fd9 prompts: null configuration: autoValidationConfidenceThreshold: 70 Generative Extraction: value: - documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + documentId: 7d38d17f-978f-4089-b086-02982bbb5fd9 prompts: - id: Invoice Number question: Extract the invoice number from the provided document. @@ -2669,7 +2669,7 @@ paths: get: tags: - Extraction - summary: "" + summary: Retrieve extraction result description: "Monitor the status and retrieve the extraction result once the operation is completed.\r\n\nRequired scopes: Du.Extraction.Api
" operationId: GetExtractionResult parameters: @@ -2777,7 +2777,7 @@ paths: get: tags: - Extraction - summary: "" + summary: Retrieve extraction result description: "Monitor the status and retrieve the extraction result once the operation is completed.\r\n\nRequired scopes: Du.Extraction.Api
" operationId: GetDocTypeExtractionResult parameters: @@ -2886,7 +2886,7 @@ paths: post: tags: - Validation - summary: "" + summary: Start classification validation description: "Start classification validation operation. To monitor the status and retrieve the validation result, use the \"Get Classification Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" operationId: StartClassificationValidation parameters: @@ -2922,7 +2922,7 @@ paths: value: classificationResults: - DocumentTypeId: invoice - DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + DocumentId: 1b856587-51b7-4f12-8af2-4c8351031f97 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -2946,7 +2946,7 @@ paths: TextLength: 1 ClassifierName: ML Classification prompts: null - documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + documentId: 1b856587-51b7-4f12-8af2-4c8351031f97 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -2957,7 +2957,7 @@ paths: value: classificationResults: - DocumentTypeId: Invoice - DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + DocumentId: 1b856587-51b7-4f12-8af2-4c8351031f97 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -2985,7 +2985,7 @@ paths: description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - name: Receipt description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + documentId: 1b856587-51b7-4f12-8af2-4c8351031f97 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3000,7 +3000,7 @@ paths: value: classificationResults: - DocumentTypeId: invoice - DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + DocumentId: 1b856587-51b7-4f12-8af2-4c8351031f97 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3024,7 +3024,7 @@ paths: TextLength: 1 ClassifierName: ML Classification prompts: null - documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + documentId: 1b856587-51b7-4f12-8af2-4c8351031f97 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3035,7 +3035,7 @@ paths: value: classificationResults: - DocumentTypeId: Invoice - DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + DocumentId: 1b856587-51b7-4f12-8af2-4c8351031f97 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3063,7 +3063,7 @@ paths: description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - name: Receipt description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + documentId: 1b856587-51b7-4f12-8af2-4c8351031f97 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3078,7 +3078,7 @@ paths: value: classificationResults: - DocumentTypeId: invoice - DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + DocumentId: 1b856587-51b7-4f12-8af2-4c8351031f97 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3102,7 +3102,7 @@ paths: TextLength: 1 ClassifierName: ML Classification prompts: null - documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + documentId: 1b856587-51b7-4f12-8af2-4c8351031f97 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3113,7 +3113,7 @@ paths: value: classificationResults: - DocumentTypeId: Invoice - DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + DocumentId: 1b856587-51b7-4f12-8af2-4c8351031f97 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3141,7 +3141,7 @@ paths: description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - name: Receipt description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + documentId: 1b856587-51b7-4f12-8af2-4c8351031f97 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3238,7 +3238,7 @@ paths: post: tags: - Validation - summary: "" + summary: Start classification validation description: "Start classification validation operation. To monitor the status and retrieve the validation result, use the \"Get Classification Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" operationId: StartClassificationValidation parameters: @@ -3271,7 +3271,7 @@ paths: value: classificationResults: - DocumentTypeId: invoice - DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + DocumentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3295,7 +3295,7 @@ paths: TextLength: 1 ClassifierName: ML Classification prompts: null - documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + documentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3306,7 +3306,7 @@ paths: value: classificationResults: - DocumentTypeId: Invoice - DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + DocumentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3334,7 +3334,7 @@ paths: description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - name: Receipt description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + documentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3349,7 +3349,7 @@ paths: value: classificationResults: - DocumentTypeId: invoice - DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + DocumentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3373,7 +3373,7 @@ paths: TextLength: 1 ClassifierName: ML Classification prompts: null - documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + documentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3384,7 +3384,7 @@ paths: value: classificationResults: - DocumentTypeId: Invoice - DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + DocumentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3412,7 +3412,7 @@ paths: description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - name: Receipt description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + documentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3427,7 +3427,7 @@ paths: value: classificationResults: - DocumentTypeId: invoice - DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + DocumentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3451,7 +3451,7 @@ paths: TextLength: 1 ClassifierName: ML Classification prompts: null - documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + documentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3462,7 +3462,7 @@ paths: value: classificationResults: - DocumentTypeId: Invoice - DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + DocumentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 Confidence: 0.0 OcrConfidence: 0.0 Reference: @@ -3490,7 +3490,7 @@ paths: description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - name: Receipt description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + documentId: ca5c3561-edf8-4a76-bfb2-14f6ac550e23 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3587,7 +3587,7 @@ paths: get: tags: - Validation - summary: "" + summary: Retrieve classification validation result description: "Monitor the status and retrieve the classification validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" operationId: GetClassificationValidationResult parameters: @@ -3707,7 +3707,7 @@ paths: get: tags: - Validation - summary: "" + summary: Retrieve classification validation result description: "Monitor the status and retrieve the classification validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" operationId: GetClassificationValidationResultByTag parameters: @@ -3824,7 +3824,7 @@ paths: post: tags: - Validation - summary: "" + summary: Start extraction validation description: "Start extraction validation operation. To monitor the status and retrieve the validation result, use the \"Get Extraction Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" operationId: StartExtractionValidation parameters: @@ -3859,7 +3859,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + DocumentId: 062a7803-3f1b-4f55-bdf9-89252880938a ResultsVersion: 0 ResultsDocument: Bounds: @@ -4033,7 +4033,7 @@ paths: prompts: null fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + documentId: 062a7803-3f1b-4f55-bdf9-89252880938a actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -4043,7 +4043,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + DocumentId: 062a7803-3f1b-4f55-bdf9-89252880938a ResultsVersion: 0 ResultsDocument: Bounds: @@ -4223,7 +4223,7 @@ paths: question: Extract the total amount from the invoice. fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + documentId: 062a7803-3f1b-4f55-bdf9-89252880938a actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -4237,7 +4237,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + DocumentId: 062a7803-3f1b-4f55-bdf9-89252880938a ResultsVersion: 0 ResultsDocument: Bounds: @@ -4411,7 +4411,7 @@ paths: prompts: null fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + documentId: 062a7803-3f1b-4f55-bdf9-89252880938a actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -4421,7 +4421,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + DocumentId: 062a7803-3f1b-4f55-bdf9-89252880938a ResultsVersion: 0 ResultsDocument: Bounds: @@ -4601,7 +4601,7 @@ paths: question: Extract the total amount from the invoice. fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + documentId: 062a7803-3f1b-4f55-bdf9-89252880938a actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -4615,7 +4615,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + DocumentId: 062a7803-3f1b-4f55-bdf9-89252880938a ResultsVersion: 0 ResultsDocument: Bounds: @@ -4789,7 +4789,7 @@ paths: prompts: null fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + documentId: 062a7803-3f1b-4f55-bdf9-89252880938a actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -4799,7 +4799,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + DocumentId: 062a7803-3f1b-4f55-bdf9-89252880938a ResultsVersion: 0 ResultsDocument: Bounds: @@ -4979,7 +4979,7 @@ paths: question: Extract the total amount from the invoice. fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + documentId: 062a7803-3f1b-4f55-bdf9-89252880938a actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -5076,7 +5076,7 @@ paths: post: tags: - Validation - summary: "" + summary: Start extraction validation description: "Start extraction validation by document type operation. To monitor the status and retrieve the validation result, use the \"Get Document Type Extraction Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" operationId: StartDocTypeExtractionValidation parameters: @@ -5112,7 +5112,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + DocumentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 ResultsVersion: 0 ResultsDocument: Bounds: @@ -5286,7 +5286,7 @@ paths: prompts: null fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + documentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -5296,7 +5296,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + DocumentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 ResultsVersion: 0 ResultsDocument: Bounds: @@ -5476,7 +5476,7 @@ paths: question: Extract the total amount from the invoice. fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + documentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -5490,7 +5490,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + DocumentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 ResultsVersion: 0 ResultsDocument: Bounds: @@ -5664,7 +5664,7 @@ paths: prompts: null fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + documentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -5674,7 +5674,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + DocumentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 ResultsVersion: 0 ResultsDocument: Bounds: @@ -5854,7 +5854,7 @@ paths: question: Extract the total amount from the invoice. fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + documentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -5868,7 +5868,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + DocumentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 ResultsVersion: 0 ResultsDocument: Bounds: @@ -6042,7 +6042,7 @@ paths: prompts: null fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + documentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -6052,7 +6052,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + DocumentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 ResultsVersion: 0 ResultsDocument: Bounds: @@ -6232,7 +6232,7 @@ paths: question: Extract the total amount from the invoice. fieldsValidationConfidence: null allowChangeOfDocumentType: null - documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e + documentId: 96e341ca-e579-42e7-b6aa-6bf883fe9255 actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -6329,7 +6329,7 @@ paths: get: tags: - Validation - summary: "" + summary: Retrieve extraction validation result description: "Monitor the status and retrieve the extraction validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" operationId: GetExtractionValidationResult parameters: @@ -6449,7 +6449,7 @@ paths: get: tags: - Validation - summary: "" + summary: Retrieve the extraction validation result description: "Monitor the status and retrieve the extraction validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" operationId: GetDocTypeExtractionValidationResult parameters: @@ -7450,6 +7450,10 @@ components: projectVersionName: type: string nullable: true + createdOn: + type: string + format: date-time + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DocumentType: type: object @@ -7534,6 +7538,10 @@ components: nullable: true type: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Discovery.Model.ClassifierDocumentTypeType' + createdOn: + type: string + format: date-time + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetClassifierDetailsResponse: type: object @@ -7597,6 +7605,10 @@ components: type: integer format: int32 nullable: true + createdOn: + type: string + format: date-time + nullable: true classifiers: type: array items: @@ -7683,6 +7695,8 @@ components: description: type: string nullable: true + type: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ProjectType' documentTypes: type: array items: @@ -7735,6 +7749,8 @@ components: name: type: string nullable: true + type: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ProjectType' description: type: string nullable: true @@ -7759,6 +7775,12 @@ components: format: uri nullable: true additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ProjectType: + enum: + - Classic + - Modern + - IXP + type: string UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ResourceStatus: enum: - Unknown @@ -8291,7 +8313,7 @@ components: description: In order to enable access to the Cloud APIs you have to create an external application with the desired scopes. After the external application is registered, you can use the App ID & App Secret in order to Authorize. flows: clientCredentials: - tokenUrl: https://cloud.uipath.com/identity_/connect/token + tokenUrl: https://alpha.uipath.com/identity_/connect/token scopes: Du.Digitization.Api: Digitization Api Scope Du.Classification.Api: Classification Api Scope diff --git a/definitions/identity.yaml b/definitions/identity.yaml index 9f90174..d3550d6 100644 --- a/definitions/identity.yaml +++ b/definitions/identity.yaml @@ -1,8 +1,8 @@ openapi: 3.0.1 info: title: IdentityServer External API - version: 3.1.10 - x-uipath-version: 3.1.10 + version: 3.2.4 + x-uipath-version: 3.2.4 servers: - url: https://cloud.uipath.com/identity_ paths: diff --git a/definitions/orchestrator.yaml b/definitions/orchestrator.yaml index fb4c6fc..c526d06 100644 --- a/definitions/orchestrator.yaml +++ b/definitions/orchestrator.yaml @@ -14,29 +14,6 @@ servers: description: The tenant name (or id) default: my-tenant paths: - /api/Account/Authenticate: - post: - tags: - - Account - summary: Authenticates the user based on user name and password - description: "Authenticates the user based on user name and password.\nDEPRECATED: \nPlease user other means to authenticate in your application. This endpoint will be removed in future releases.\nPlease refer to https://docs.uipath.com/orchestrator/reference" - operationId: Account_Authenticate - requestBody: - description: The login parameters. - content: - application/json: - schema: - $ref: '#/components/schemas/LoginModel' - required: false - responses: - "200": - description: Successful authentication - content: - application/json: - schema: - $ref: '#/components/schemas/AjaxResponse' - deprecated: true - x-codegen-request-body-name: body /api/DirectoryService/GetDirectoryPermissions: get: tags: @@ -239,6 +216,36 @@ paths: content: {} security: - OAuth2: [] + /api/Folders/GetAllForCurrentUser: + get: + tags: + - Folders + summary: "Returns a subset (paginated) of the folders the current user has access to.\r\nThe response will be a list of folders;" + description: |- + OAuth required scopes: OR.Folders or OR.Folders.Read. + + Requires authentication. + operationId: Folders_GetAllForCurrentUser + parameters: + - name: take + in: query + schema: + type: integer + format: int32 + - name: skip + in: query + schema: + type: integer + format: int32 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PageResultDtoOfCurrentUserFolderDto' + security: + - OAuth2: [] /api/Folders/PatchNameDescription: patch: tags: @@ -2710,7 +2717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RobotAssetDto' + $ref: '#/components/schemas/UserAssetDto' "400": description: Invalid parameters content: {} @@ -2800,7 +2807,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RobotAssetDto' + $ref: '#/components/schemas/UserAssetDto' "400": description: Invalid parameters content: {} @@ -2858,7 +2865,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RobotAssetDto' + $ref: '#/components/schemas/UserAssetDto' "400": description: Invalid parameters content: {} @@ -4103,16 +4110,16 @@ paths: security: - OAuth2: [] x-codegen-request-body-name: body - /odata/Calendars: + /odata/BusinessRules: get: tags: - - Calendars - summary: Gets calendars for current tenant. + - BusinessRules + summary: Get Filtered Business Rules description: |- - OAuth required scopes: OR.Settings or OR.Settings.Read. + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read. - Requires authentication. - operationId: Calendars_Get + Required permissions: (BusinessRules.View). + operationId: BusinessRules_Get parameters: - name: $expand in: query @@ -4121,7 +4128,7 @@ paths: type: string - name: $filter in: query - description: 'Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.' + description: Restricts the set of items returned. The maximum number of expressions is 100. schema: type: string - name: $select @@ -4131,12 +4138,12 @@ paths: type: string - name: $orderby in: query - description: 'Specifies the order in which items are returned. The maximum number of expressions is 5. The allowed properties are: Name, Id.' + description: Specifies the order in which items are returned. The maximum number of expressions is 5. schema: type: string - name: $top in: query - description: Limits the number of items returned from a collection. + description: Limits the number of items returned from a collection. The maximum value is 1000. schema: type: integer format: int32 @@ -4151,89 +4158,76 @@ paths: description: Indicates whether the total count of items within a collection are returned in the result. schema: type: boolean + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true responses: "200": description: Success content: application/json: schema: - $ref: '#/components/schemas/ODataValueOfIEnumerableOfExtendedCalendarDto' + $ref: '#/components/schemas/ODataValueOfIEnumerableOfBusinessRuleDto' security: - OAuth2: [] post: tags: - - Calendars - summary: Creates a new calendar. + - BusinessRules + summary: Create Business Rule description: |- - OAuth required scopes: OR.Settings or OR.Settings.Write. + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write. - Required permissions: (Settings.Create). - operationId: Calendars_Post + Required permissions: (BusinessRules.Create). + operationId: BusinessRules_Post + parameters: + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true requestBody: content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json-patch+json: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/*+json: + multipart/form-data: schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - required: false + required: + - businessRule + - file + type: object + properties: + file: + type: string + format: binary + businessRule: + type: string + description: The BusinessRuleDto object + required: true responses: "201": - description: Created + description: Successfully created the business rule content: application/json: schema: - $ref: '#/components/schemas/ExtendedCalendarDto' + $ref: '#/components/schemas/BusinessRuleDto' security: - OAuth2: [] - x-codegen-request-body-name: body - /odata/Calendars({key}): + /odata/BusinessRules({key}): get: tags: - - Calendars - summary: Gets calendar based on its id. + - BusinessRules + summary: Get Business Rule by id description: |- - OAuth required scopes: OR.Settings or OR.Settings.Read. + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read. - Requires authentication. - operationId: Calendars_GetById + Required permissions: (BusinessRules.View). + operationId: BusinessRules_GetById parameters: - name: key in: path @@ -4251,24 +4245,35 @@ paths: description: Limits the properties returned in the result. schema: type: string + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true responses: "200": description: Success content: application/json: schema: - $ref: '#/components/schemas/ExtendedCalendarDto' + $ref: '#/components/schemas/BusinessRuleDto' + "404": + description: Business Rule not found + content: {} security: - OAuth2: [] put: tags: - - Calendars - summary: Edits a calendar. + - BusinessRules + summary: Update Business Rule description: |- - OAuth required scopes: OR.Settings or OR.Settings.Write. + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write. - Required permissions: (Settings.Edit). - operationId: Calendars_PutById + Required permissions: (BusinessRules.Edit). + operationId: BusinessRules_PutById parameters: - name: key in: path @@ -4276,70 +4281,47 @@ paths: schema: type: integer format: int64 + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true requestBody: content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/json-patch+json: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - application/*+json: + multipart/form-data: schema: - $ref: '#/components/schemas/ExtendedCalendarDto' - required: false + required: + - businessRule + type: object + properties: + file: + type: string + format: binary + businessRule: + type: string + description: The BusinessRuleDto object + required: true responses: "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ExtendedCalendarDto' + description: Successfully updated the business rule + content: {} + "404": + description: Business Rule not found + content: {} security: - OAuth2: [] - x-codegen-request-body-name: body delete: tags: - - Calendars - summary: Deletes a calendar. + - BusinessRules + summary: Delete business rule description: |- - OAuth required scopes: OR.Settings or OR.Settings.Write. + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write. - Required permissions: (Settings.Delete). - operationId: Calendars_DeleteById + Required permissions: (BusinessRules.Delete). + operationId: BusinessRules_DeleteById parameters: - name: key in: path @@ -4347,99 +4329,749 @@ paths: schema: type: integer format: int64 + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true responses: "204": description: No Content content: {} security: - OAuth2: [] - /odata/Calendars/UiPath.Server.Configuration.OData.CalendarExists: - post: + /odata/BusinessRules/UiPath.Server.Configuration.OData.GetBusinessRulesAcrossFolders: + get: tags: - - Calendars - summary: Validate calendar name, and check if it already exists. + - BusinessRules + summary: Get the business rules from all the folders in which the current user has the BusinessRules.View permission, except the one specified. description: |- - OAuth required scopes: OR.Settings or OR.Settings.Write. + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read. - Required permissions: (Settings.Edit). - operationId: Calendars_CalendarExists + Requires authentication. + operationId: BusinessRules_GetBusinessRulesAcrossFolders parameters: - - name: $expand - in: query - description: Indicates the related entities to be represented inline. The maximum depth is 2. - schema: - type: string - - name: $select + - name: excludeFolderId in: query - description: Limits the properties returned in the result. schema: - type: string - requestBody: - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/json-patch+json: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - application/*+json: - schema: - $ref: '#/components/schemas/CalendarExistsRequest' - required: false - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ODataValueOfBoolean' - security: - - OAuth2: [] - x-codegen-request-body-name: body - /odata/CredentialStores: - get: - tags: - - CredentialStores - summary: Gets all Credential Stores. - description: |- - OAuth required scopes: OR.Settings or OR.Settings.Read. - - Required permissions: Settings.View or Assets.Create or Assets.Edit or Assets.View or Robots.Create or Robots.Edit or Robots.View or Buckets.Create or Buckets.Edit. - operationId: CredentialStores_Get - parameters: + type: integer + format: int64 + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $filter + in: query + description: Restricts the set of items returned. The maximum number of expressions is 100. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: $orderby + in: query + description: Specifies the order in which items are returned. The maximum number of expressions is 5. + schema: + type: string + - name: $top + in: query + description: Limits the number of items returned from a collection. The maximum value is 1000. + schema: + type: integer + format: int32 + - name: $skip + in: query + description: Excludes the specified number of items of the queried collection from the result. + schema: + type: integer + format: int32 + - name: $count + in: query + description: Indicates whether the total count of items within a collection are returned in the result. + schema: + type: boolean + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ODataValueOfIEnumerableOfBusinessRuleDto' + security: + - OAuth2: [] + /odata/BusinessRules/UiPath.Server.Configuration.OData.GetByKey(identifier={identifier}): + get: + tags: + - BusinessRules + summary: Get Business Rule by key + description: |- + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read. + + Required permissions: (BusinessRules.View). + operationId: BusinessRules_GetByKeyByIdentifier + parameters: + - name: identifier + in: path + required: true + schema: + type: string + format: uuid + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $filter + in: query + description: Restricts the set of items returned. The maximum number of expressions is 100. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: $orderby + in: query + description: Specifies the order in which items are returned. The maximum number of expressions is 5. + schema: + type: string + - name: $top + in: query + description: Limits the number of items returned from a collection. The maximum value is 1000. + schema: + type: integer + format: int32 + - name: $skip + in: query + description: Excludes the specified number of items of the queried collection from the result. + schema: + type: integer + format: int32 + - name: $count + in: query + description: Indicates whether the total count of items within a collection are returned in the result. + schema: + type: boolean + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BusinessRuleDto' + "404": + description: Business Rule not found + content: {} + security: + - OAuth2: [] + /odata/BusinessRules/UiPath.Server.Configuration.OData.GetFoldersForBusinessRule(id={id}): + get: + tags: + - BusinessRules + summary: Get all accesible folders where the business rule is shared, and the total count of folders where it is shared (including unaccessible folders). + description: |- + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read. + + Requires authentication. + operationId: BusinessRules_GetFoldersForBusinessRuleById + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccessibleFoldersDto' + security: + - OAuth2: [] + /odata/BusinessRules/UiPath.Server.Configuration.OData.GetReadUri(name='{name}'): + get: + tags: + - BusinessRules + summary: Get Read URI by Name + description: |- + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read. + + Required permissions: (BusinessRules.View). + operationId: BusinessRules_GetReadUriByName + parameters: + - name: name + in: path + required: true + schema: + type: string + - name: versionNumber + in: query + schema: + type: string + - name: expiryInMinutes + in: query + schema: + type: integer + format: int32 + default: 30 + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BusinessRuleVersionDownloadResponse' + "404": + description: Business Rule not found + content: {} + security: + - OAuth2: [] + /odata/BusinessRules/UiPath.Server.Configuration.OData.GetVersionList(name='{name}'): + get: + tags: + - BusinessRules + summary: Get Versions of Business Rule + description: |- + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read. + + Required permissions: (BusinessRules.View). + operationId: BusinessRules_GetVersionListByName + parameters: + - name: name + in: path + required: true + schema: + type: string + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $filter + in: query + description: Restricts the set of items returned. The maximum number of expressions is 100. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: $orderby + in: query + description: Specifies the order in which items are returned. The maximum number of expressions is 5. + schema: + type: string + - name: $top + in: query + description: Limits the number of items returned from a collection. The maximum value is 1000. + schema: + type: integer + format: int32 + - name: $skip + in: query + description: Excludes the specified number of items of the queried collection from the result. + schema: + type: integer + format: int32 + - name: $count + in: query + description: Indicates whether the total count of items within a collection are returned in the result. + schema: + type: boolean + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ODataValueOfIEnumerableOfBusinessRuleVersionDto' + "404": + description: Business Rule not found + content: {} + security: + - OAuth2: [] + /odata/BusinessRules/UiPath.Server.Configuration.OData.ShareToFolders: + post: + tags: + - BusinessRules + summary: Makes the business rule visible in the specified folders. + description: |- + OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write. + + Requires authentication. + operationId: BusinessRules_ShareToFolders + parameters: + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + requestBody: + description: Object containing the ids of the business rules and the ids of the folders where they should be shared. + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + application/*+json: + schema: + $ref: '#/components/schemas/BusinessRuleFolderShareRequest' + required: false + responses: + "204": + description: No Content + content: {} + "404": + description: A business rule or one of the folders specified does not exist. + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body + /odata/Calendars: + get: + tags: + - Calendars + summary: Gets calendars for current tenant. + description: |- + OAuth required scopes: OR.Settings or OR.Settings.Read. + + Requires authentication. + operationId: Calendars_Get + parameters: + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $filter + in: query + description: 'Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.' + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: $orderby + in: query + description: 'Specifies the order in which items are returned. The maximum number of expressions is 5. The allowed properties are: Name, Id.' + schema: + type: string + - name: $top + in: query + description: Limits the number of items returned from a collection. + schema: + type: integer + format: int32 + - name: $skip + in: query + description: Excludes the specified number of items of the queried collection from the result. + schema: + type: integer + format: int32 + - name: $count + in: query + description: Indicates whether the total count of items within a collection are returned in the result. + schema: + type: boolean + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ODataValueOfIEnumerableOfExtendedCalendarDto' + security: + - OAuth2: [] + post: + tags: + - Calendars + summary: Creates a new calendar. + description: |- + OAuth required scopes: OR.Settings or OR.Settings.Write. + + Required permissions: (Settings.Create). + operationId: Calendars_Post + requestBody: + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json-patch+json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/*+json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + required: false + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + security: + - OAuth2: [] + x-codegen-request-body-name: body + /odata/Calendars({key}): + get: + tags: + - Calendars + summary: Gets calendar based on its id. + description: |- + OAuth required scopes: OR.Settings or OR.Settings.Read. + + Requires authentication. + operationId: Calendars_GetById + parameters: + - name: key + in: path + required: true + schema: + type: integer + format: int64 + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + security: + - OAuth2: [] + put: + tags: + - Calendars + summary: Edits a calendar. + description: |- + OAuth required scopes: OR.Settings or OR.Settings.Write. + + Required permissions: (Settings.Edit). + operationId: Calendars_PutById + parameters: + - name: key + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/json-patch+json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + application/*+json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + required: false + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExtendedCalendarDto' + security: + - OAuth2: [] + x-codegen-request-body-name: body + delete: + tags: + - Calendars + summary: Deletes a calendar. + description: |- + OAuth required scopes: OR.Settings or OR.Settings.Write. + + Required permissions: (Settings.Delete). + operationId: Calendars_DeleteById + parameters: + - name: key + in: path + required: true + schema: + type: integer + format: int64 + responses: + "204": + description: No Content + content: {} + security: + - OAuth2: [] + /odata/Calendars/UiPath.Server.Configuration.OData.CalendarExists: + post: + tags: + - Calendars + summary: Validate calendar name, and check if it already exists. + description: |- + OAuth required scopes: OR.Settings or OR.Settings.Write. + + Required permissions: (Settings.Edit). + operationId: Calendars_CalendarExists + parameters: + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + requestBody: + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/CalendarExistsRequest' + required: false + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ODataValueOfBoolean' + security: + - OAuth2: [] + x-codegen-request-body-name: body + /odata/CredentialStores: + get: + tags: + - CredentialStores + summary: Gets all Credential Stores. + description: |- + OAuth required scopes: OR.Settings or OR.Settings.Read. + + Required permissions: Settings.View or Assets.Create or Assets.Edit or Assets.View or Robots.Create or Robots.Edit or Robots.View or Buckets.Create or Buckets.Edit. + operationId: CredentialStores_Get + parameters: - name: $expand in: query description: Indicates the related entities to be represented inline. The maximum depth is 2. @@ -7055,803 +7687,133 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ODataValueOfIEnumerableOfUserRolesDto' - security: - - OAuth2: [] - /odata/Folders/UiPath.Server.Configuration.OData.ToggleFolderMachineInherit: - post: - tags: - - Folders - summary: Toggle machine propagation for a folder to all subfolders. - description: |- - OAuth required scopes: OR.Folders or OR.Folders.Write. - - Required permissions: (Units.Edit or SubFolders.Edit - Propagate machine to subfolders only if Units.Edit permission is provided or only if SubFolders.Edit permission on all folders provided). - operationId: Folders_ToggleFolderMachineInherit - requestBody: - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/json-patch+json: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - application/*+json: - schema: - $ref: '#/components/schemas/FolderMachineInheritDto' - required: false - responses: - "200": - description: Success - content: {} - security: - - OAuth2: [] - x-codegen-request-body-name: body - /odata/Folders/UiPath.Server.Configuration.OData.UpdateMachinesToFolderAssociations: - post: - tags: - - Folders - summary: Add and remove machine associations to a folder - description: |- - OAuth required scopes: OR.Folders or OR.Folders.Write. - - Required permissions: (Units.Edit or SubFolders.Edit - Update machines to any folder associations or only if user has SubFolders.Edit permission on all folders provided). - operationId: Folders_UpdateMachinesToFolderAssociations - requestBody: - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/json-patch+json: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - application/*+json: - schema: - $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' - required: false - responses: - "204": - description: No Content - content: {} - security: - - OAuth2: [] - x-codegen-request-body-name: body - /odata/HostLicenses: - get: - tags: - - HostLicenses - summary: Gets host licenses. - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Read. - - Host only. Requires authentication. - operationId: HostLicenses_Get - parameters: - - name: $expand - in: query - description: Indicates the related entities to be represented inline. The maximum depth is 2. - schema: - type: string - - name: $filter - in: query - description: Restricts the set of items returned. The maximum number of expressions is 100. - schema: - type: string - - name: $select - in: query - description: Limits the properties returned in the result. - schema: - type: string - - name: $orderby - in: query - description: Specifies the order in which items are returned. The maximum number of expressions is 5. - schema: - type: string - - name: $top - in: query - description: Limits the number of items returned from a collection. The maximum value is 1000. - schema: - type: integer - format: int32 - - name: $skip - in: query - description: Excludes the specified number of items of the queried collection from the result. - schema: - type: integer - format: int32 - - name: $count - in: query - description: Indicates whether the total count of items within a collection are returned in the result. - schema: - type: boolean - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ODataValueOfIEnumerableOfHostLicenseDto' - security: - - OAuth2: [] - /odata/HostLicenses({key}): - get: - tags: - - HostLicenses - summary: Gets a single host license based on its key. - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Read. - - Host only. Requires authentication. - operationId: HostLicenses_GetById - parameters: - - name: key - in: path - required: true - schema: - type: integer - format: int64 - - name: $expand - in: query - description: Indicates the related entities to be represented inline. The maximum depth is 2. - schema: - type: string - - name: $select - in: query - description: Limits the properties returned in the result. - schema: - type: string - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/HostLicenseDto' - "404": - description: Not Found - content: {} - security: - - OAuth2: [] - delete: - tags: - - HostLicenses - summary: Deletes a host license based on its key. - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_DeleteById - parameters: - - name: key - in: path - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: No Content - content: {} - "404": - description: Not Found - content: {} - security: - - OAuth2: [] - /odata/HostLicenses/UiPath.Server.Configuration.OData.ActivateLicenseOffline: - post: - tags: - - HostLicenses - summary: "Uploads a new offline license activation.\r\nThe content of the license is sent as a file embedded in the HTTP request." - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_ActivateLicenseOffline - requestBody: - content: - multipart/form-data: - schema: - required: - - file - type: object - properties: - file: - type: string - format: binary - required: true - responses: - "200": - description: Success - content: {} - "400": - description: Bad Request - content: {} - security: - - OAuth2: [] - /odata/HostLicenses/UiPath.Server.Configuration.OData.ActivateLicenseOnline: - post: - tags: - - HostLicenses - summary: Activate the license for the host - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_ActivateLicenseOnline - requestBody: - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/json-patch+json: - schema: - $ref: '#/components/schemas/LicenseRequest' - application/*+json: - schema: - $ref: '#/components/schemas/LicenseRequest' - required: false - responses: - "200": - description: Success - content: {} - "400": - description: Invalid parameters - content: {} - security: - - OAuth2: [] - x-codegen-request-body-name: body - /odata/HostLicenses/UiPath.Server.Configuration.OData.DeactivateLicenseOnline: - post: - tags: - - HostLicenses - summary: Deactivate the license for the host - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_DeactivateLicenseOnline - requestBody: - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json-patch+json: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/*+json: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - required: false - responses: - "200": - description: Success - content: {} - "400": - description: Invalid parameters - content: {} - security: - - OAuth2: [] - x-codegen-request-body-name: body - /odata/HostLicenses/UiPath.Server.Configuration.OData.DeleteTenantLicense: - post: - tags: - - HostLicenses - summary: Deletes a tenant license based on its key. - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_DeleteTenantLicense - requestBody: - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/json-patch+json: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - application/*+json: - schema: - $ref: '#/components/schemas/HostDeleteTenantLicenseRequest' - required: false - responses: - "200": - description: Success - content: {} - "400": - description: Invalid parameters - content: {} - security: - - OAuth2: [] - x-codegen-request-body-name: body - /odata/HostLicenses/UiPath.Server.Configuration.OData.GetDeactivateLicenseOffline: - post: - tags: - - HostLicenses - summary: Deactivate the license offline for the host - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_GetDeactivateLicenseOffline - parameters: - - name: $expand - in: query - description: Indicates the related entities to be represented inline. The maximum depth is 2. - schema: - type: string - - name: $select - in: query - description: Limits the properties returned in the result. - schema: - type: string - requestBody: - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/json-patch+json: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - application/*+json: - schema: - $ref: '#/components/schemas/DeactivateLicenseRequest' - required: false - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ODataValueOfString' - "400": - description: Invalid parameters - content: {} + $ref: '#/components/schemas/ODataValueOfIEnumerableOfUserRolesDto' security: - OAuth2: [] - x-codegen-request-body-name: body - /odata/HostLicenses/UiPath.Server.Configuration.OData.GetLicenseOffline: + /odata/Folders/UiPath.Server.Configuration.OData.ToggleFolderMachineInherit: post: tags: - - HostLicenses - summary: Create the offline activation request for the host + - Folders + summary: Toggle machine propagation for a folder to all subfolders. description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. + OAuth required scopes: OR.Folders or OR.Folders.Write. - Host only. Requires authentication. - operationId: HostLicenses_GetLicenseOffline - parameters: - - name: $expand - in: query - description: Indicates the related entities to be represented inline. The maximum depth is 2. - schema: - type: string - - name: $select - in: query - description: Limits the properties returned in the result. - schema: - type: string + Required permissions: (Units.Edit or SubFolders.Edit - Propagate machine to subfolders only if Units.Edit permission is provided or only if SubFolders.Edit permission on all folders provided). + operationId: Folders_ToggleFolderMachineInherit requestBody: content: application/json;odata.metadata=minimal;odata.streaming=true: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=minimal;odata.streaming=false: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=minimal: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=full;odata.streaming=true: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=full;odata.streaming=false: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=full: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=none;odata.streaming=true: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=none;odata.streaming=false: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.metadata=none: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.streaming=true: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json;odata.streaming=false: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/json-patch+json: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' application/*+json: schema: - $ref: '#/components/schemas/LicenseRequest' + $ref: '#/components/schemas/FolderMachineInheritDto' required: false responses: "200": description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ODataValueOfString' - "400": - description: Invalid parameters content: {} security: - OAuth2: [] x-codegen-request-body-name: body - /odata/HostLicenses/UiPath.Server.Configuration.OData.GetTenantLicense(tenantId={tenantId}): - get: - tags: - - HostLicenses - summary: Gets a single tenant license based on its id. - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Read. - - Host only. Requires authentication. - operationId: HostLicenses_GetTenantLicenseByTenantid - parameters: - - name: tenantId - in: path - required: true - schema: - type: integer - format: int32 - - name: $expand - in: query - description: Indicates the related entities to be represented inline. The maximum depth is 2. - schema: - type: string - - name: $select - in: query - description: Limits the properties returned in the result. - schema: - type: string - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/LicenseDto' - security: - - OAuth2: [] - /odata/HostLicenses/UiPath.Server.Configuration.OData.SetTenantLicense: + /odata/Folders/UiPath.Server.Configuration.OData.UpdateMachinesToFolderAssociations: post: tags: - - HostLicenses - summary: Sets the license for a specific tenant + - Folders + summary: Add and remove machine associations to a folder description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. + OAuth required scopes: OR.Folders or OR.Folders.Write. - Host only. Requires authentication. - operationId: HostLicenses_SetTenantLicense + Required permissions: (Units.Edit or SubFolders.Edit - Update machines to any folder associations or only if user has SubFolders.Edit permission on all folders provided). + operationId: Folders_UpdateMachinesToFolderAssociations requestBody: content: application/json;odata.metadata=minimal;odata.streaming=true: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=minimal: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=full;odata.streaming=true: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=full;odata.streaming=false: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=full: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=none;odata.streaming=true: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=none;odata.streaming=false: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.metadata=none: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.streaming=true: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json;odata.streaming=false: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/json-patch+json: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' application/*+json: schema: - $ref: '#/components/schemas/HostSetTenantLicenseRequest' + $ref: '#/components/schemas/UpdateMachinesToFolderAssociationsRequest' required: false responses: - "200": - description: Success - content: {} - "400": - description: Invalid parameters + "204": + description: No Content content: {} security: - OAuth2: [] x-codegen-request-body-name: body - /odata/HostLicenses/UiPath.Server.Configuration.OData.UpdateLicenseOnline: - post: - tags: - - HostLicenses - summary: Update the license for the host - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_UpdateLicenseOnline - responses: - "200": - description: Success - content: {} - "400": - description: Invalid parameters - content: {} - security: - - OAuth2: [] - /odata/HostLicenses/UiPath.Server.Configuration.OData.UploadLicense: - post: - tags: - - HostLicenses - summary: "Uploads a new host license file that was previously generated with Regutil.\r\nThe content of the license is sent as a file embedded in the HTTP request." - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: HostLicenses_UploadLicense - parameters: - - name: $expand - in: query - description: Indicates the related entities to be represented inline. The maximum depth is 2. - schema: - type: string - - name: $select - in: query - description: Limits the properties returned in the result. - schema: - type: string - requestBody: - content: - multipart/form-data: - schema: - required: - - file - type: object - properties: - file: - type: string - format: binary - required: true - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/HostLicenseDto' - "400": - description: Bad Request - content: {} - security: - - OAuth2: [] /odata/Jobs: get: tags: @@ -13260,7 +13222,7 @@ paths: get: tags: - QueueItems - summary: Returns the last retry of a queue item by key. + summary: Returns the last retry of a queue item by uniqueKey. description: |- OAuth required scopes: OR.Queues or OR.Queues.Read. @@ -13797,6 +13759,19 @@ paths: schema: type: integer format: int64 + - name: retentionType + in: query + schema: + type: string + enum: + - Final + - Stale + x-ms-enum: + name: RetentionType + modelAsString: false + x-ms-enum: + name: RetentionType + modelAsString: false - name: $expand in: query description: Indicates the related entities to be represented inline. The maximum depth is 2. @@ -14343,6 +14318,19 @@ paths: schema: type: integer format: int64 + - name: retentionType + in: query + schema: + type: string + enum: + - Final + - Stale + x-ms-enum: + name: RetentionType + modelAsString: false + x-ms-enum: + name: RetentionType + modelAsString: false - name: $expand in: query description: Indicates the related entities to be represented inline. The maximum depth is 2. @@ -24457,22 +24445,6 @@ components: properties: itemData: $ref: '#/components/schemas/QueueItemDataDto' - AjaxResponse: - type: object - properties: - result: - type: object - targetUrl: - type: string - success: - type: boolean - error: - $ref: '#/components/schemas/ErrorInfo' - unAuthorizedRequest: - type: boolean - __abp: - type: boolean - readOnly: true AlertDto: required: - Severity @@ -24504,6 +24476,7 @@ components: - Serverless - Export - RateLimits + - AutopilotForRobots x-enum-varnames: - Robots - Transactions @@ -24521,6 +24494,7 @@ components: - Serverless - Export - RateLimits + - AutopilotForRobots x-ms-enum: name: AlertDtoComponent modelAsString: false @@ -25473,7 +25447,7 @@ components: minLength: 1 type: string robotAsset: - $ref: '#/components/schemas/RobotAssetDto' + $ref: '#/components/schemas/UserAssetDto' AttendedRobotDto: type: object properties: @@ -25708,6 +25682,8 @@ components: - TaskSolutions - TaskDefinitions - HttpTriggers + - AutopilotForRobotsData + - BusinessRules - TestSets - TestSetSchedules - TestDataQueues @@ -25754,6 +25730,8 @@ components: - TaskSolutions - TaskDefinitions - HttpTriggers + - AutopilotForRobotsData + - BusinessRules - TestSets - TestSetSchedules - TestDataQueues @@ -25938,6 +25916,13 @@ components: type: integer format: int64 description: Stores audit information about any action performed in Orchestrator. + AutopilotForRobotsSettingsDto: + type: object + properties: + Enabled: + type: boolean + HealingEnabled: + type: boolean BlobFileAccessDto: type: object properties: @@ -26536,6 +26521,94 @@ components: maxLength: 512 type: string description: Comment to be added while doing the bulk operation + BusinessRuleDto: + required: + - Name + type: object + properties: + Key: + type: string + format: uuid + Name: + maxLength: 100 + type: string + Description: + maxLength: 250 + type: string + CurrentVersion: + $ref: '#/components/schemas/BusinessRuleVersionDto' + FoldersCount: + type: integer + description: Number of folders where the businessRule is shared. + format: int32 + Tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + LastModificationTime: + type: string + format: date-time + LastModifierUserId: + type: integer + format: int64 + CreationTime: + type: string + format: date-time + CreatorUserId: + type: integer + format: int64 + Id: + type: integer + format: int64 + BusinessRuleFolderShareRequest: + type: object + properties: + BusinessRuleIds: + type: array + items: + type: integer + format: int64 + ToAddFolderIds: + type: array + items: + type: integer + format: int64 + ToRemoveFolderIds: + type: array + items: + type: integer + format: int64 + BusinessRuleVersionDownloadResponse: + type: object + properties: + VersionNumber: + type: string + BusinessRuleName: + type: string + DownloadUri: + $ref: '#/components/schemas/UiBlobFileAccessUri' + BusinessRuleVersionDto: + type: object + properties: + BusinessRuleId: + type: integer + format: int64 + Key: + type: string + format: uuid + VersionNumber: + type: string + CreatorUserId: + type: integer + format: int64 + IsActive: + type: boolean + CreationTime: + type: string + format: date-time + Id: + type: integer + format: int64 CalendarDto: type: object properties: @@ -26781,6 +26854,49 @@ components: type: integer format: int64 description: Defines the resources such as credential stores, assets, robots or bucket for a Credentials Proxy. + CurrentUserFolderDto: + type: object + properties: + Key: + type: string + description: Unique key for the folder + format: uuid + DisplayName: + type: string + description: Display name for the folder. + FullyQualifiedName: + type: string + description: Name of folder prepended by the names of its ancestors. + Description: + type: string + description: Description of folder + FolderType: + type: string + description: Folder type + enum: + - Standard + - Personal + - Virtual + - Solution + x-enum-varnames: + - Standard + - Personal + - Virtual + - Solution + x-ms-enum: + name: CurrentUserFolderDtoFolderType + modelAsString: false + ParentId: + type: integer + description: Parent folder Id in the folder hierarchy + format: int64 + ParentKey: + type: string + description: Unique key for the parent folder + format: uuid + Id: + type: integer + format: int64 CustomEventDto: required: - EventId @@ -26836,12 +26952,6 @@ components: type: string description: A piece of text representing the value. description: Stores a custom pair of key and value for assets with type KeyValueList. - DeactivateLicenseRequest: - type: object - properties: - tenantId: - type: integer - format: int32 DefaultCredentialStoreDto: required: - ResourceType @@ -27133,20 +27243,6 @@ components: items: type: integer format: int64 - ErrorInfo: - type: object - properties: - code: - type: integer - format: int32 - message: - type: string - details: - type: string - validationErrors: - type: array - items: - $ref: '#/components/schemas/ValidationErrorInfo' ErrorResult: type: object properties: @@ -27244,6 +27340,7 @@ components: - Privileges - RateLimitsReportQueueItems - RateLimitsReportJobs + - AutopilotForRobotsData x-enum-varnames: - OrchestratorAudit - TestAutomationAudit @@ -27253,6 +27350,7 @@ components: - Privileges - RateLimitsReportQueueItems - RateLimitsReportJobs + - AutopilotForRobotsData x-ms-enum: name: ExportModelType modelAsString: false @@ -27760,6 +27858,7 @@ components: - PreviousVersionNotFound - HasRunningJobs - TenantNotFound + - BusinessRuleNotFound - PendingJobsAlreadyExist - InvalidStartJobRobotIds - UnregisteredCannotStartJobs @@ -27775,6 +27874,7 @@ components: - InvalidJobStateForSuspend - JobNotFoundByPersistenceId - SuspendJobStateNotFound + - InvalidPackageJsonVersion - ErrorPackagePublish - ErrorSavingPackageDefinition - MaxNumberJobsAlreadyExist @@ -28101,6 +28201,7 @@ components: - EventTriggerCreateFailedConnectionNotAvailable - UserHasNoRobotToFireUserEventTrigger - ConnectedEventTriggerStatePatchFail + - ConnectedEventTriggerOnShellConnectionError - CredentialsProxyNotFound - CannotDeleteCredentialsProxyInUse - CredentialsProxyUrlMustBeHttps @@ -28153,6 +28254,7 @@ components: - InvalidMerge - SolutionConnectionInfoInvalid - ExportTimeout + - ExportTenantDailyLimitReached - InvalidMessageReceived - IntegrationServiceApiFailure - JobFaulted @@ -28340,6 +28442,7 @@ components: - PreviousVersionNotFound - HasRunningJobs - TenantNotFound + - BusinessRuleNotFound - PendingJobsAlreadyExist - InvalidStartJobRobotIds - UnregisteredCannotStartJobs @@ -28355,6 +28458,7 @@ components: - InvalidJobStateForSuspend - JobNotFoundByPersistenceId - SuspendJobStateNotFound + - InvalidPackageJsonVersion - ErrorPackagePublish - ErrorSavingPackageDefinition - MaxNumberJobsAlreadyExist @@ -28681,6 +28785,7 @@ components: - EventTriggerCreateFailedConnectionNotAvailable - UserHasNoRobotToFireUserEventTrigger - ConnectedEventTriggerStatePatchFail + - ConnectedEventTriggerOnShellConnectionError - CredentialsProxyNotFound - CannotDeleteCredentialsProxyInUse - CredentialsProxyUrlMustBeHttps @@ -28733,6 +28838,7 @@ components: - InvalidMerge - SolutionConnectionInfoInvalid - ExportTimeout + - ExportTenantDailyLimitReached - InvalidMessageReceived - IntegrationServiceApiFailure - JobFaulted @@ -29093,118 +29199,6 @@ components: connectionError: type: string description: "An error code that further describes the type of connection error.\r\nDoes not include TLS/SSL errors" - HostDeleteTenantLicenseRequest: - required: - - tenantId - type: object - properties: - tenantId: - type: integer - format: int32 - HostLicenseDto: - type: object - properties: - TenantsCount: - type: integer - description: The number of tenants licensed from this license file - format: int32 - Id: - type: integer - description: License Id - format: int64 - ExpireDate: - type: integer - description: License expiration date in Epoch format - format: int64 - GracePeriodEndDate: - type: integer - description: License grace period end date in Epoch format - format: int64 - GracePeriod: - type: integer - description: Number of grace period days - format: int64 - VersionControl: - type: string - description: The product version which can use this license - Allowed: - type: object - additionalProperties: - type: integer - format: int64 - description: Contains the number of allowed licenses for each type - Used: - type: object - additionalProperties: - type: integer - format: int64 - description: Contains the number of used licenses for each type - AttendedConcurrent: - type: boolean - description: States whether the license is Attended Concurrent - DevelopmentConcurrent: - type: boolean - description: States whether the license is Development Concurrent - StudioXConcurrent: - type: boolean - description: States whether the license is Studio Business Concurrent - StudioProConcurrent: - type: boolean - description: States whether the license is Studio Pro Concurrent - LicensedFeatures: - type: array - description: What features are licensed (valid for individually-licensed features, like Analytics) - items: - type: string - IsRegistered: - type: boolean - description: True if the current tenant is registered with a license. False otherwise. - IsCommunity: - type: boolean - description: True if the current tenant is registered with a community license. - IsProOrEnterprise: - type: boolean - description: True if the current tenant is registered with a pro license. - SubscriptionCode: - type: string - description: The license subscription code - SubscriptionPlan: - type: string - description: The license subscription plan - IsExpired: - type: boolean - description: States whether the license is still valid or not. - CreationTime: - type: string - description: The date when the license was uploaded. - format: date-time - Code: - type: string - description: The license code. - UserLicensingEnabled: - type: boolean - description: Whether user licensing is enabled or not. - description: Stores information about the host license used to activate one or more tenants. - HostLicensePerTenantDto: - type: object - properties: - TenantId: - type: integer - description: The tenant's Id - format: int32 - HostLicenseId: - type: integer - description: The host license's Id - format: int64 - additionalProperties: - type: object - HostSetTenantLicenseRequest: - required: - - license - type: object - properties: - license: - $ref: '#/components/schemas/HostLicensePerTenantDto' JobCompletedEventDto: required: - EventId @@ -29330,6 +29324,7 @@ components: - RobotAPI - CommandLine - RobotNetAPI + - Autopilot x-enum-varnames: - Manual - Schedule @@ -29346,6 +29341,7 @@ components: - RobotAPI - CommandLine - RobotNetAPI + - Autopilot x-ms-enum: name: JobDtoSourceType modelAsString: false @@ -29522,6 +29518,12 @@ components: LastModificationTime: type: string format: date-time + AutopilotForRobots: + $ref: '#/components/schemas/AutopilotForRobotsSettingsDto' + EnableAutopilotHealing: + type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Id: type: integer format: int64 @@ -29803,8 +29805,9 @@ components: format: uuid ItemId: type: integer - description: item Id (queue item id, task id, job id etc) + description: DEPRECATED. item Id (queue item id, task id, job id etc) format: int64 + x-deprecated: true Timer: type: string description: Resume timer (for time trigger) @@ -29867,8 +29870,9 @@ components: format: uuid ItemId: type: integer - description: item Id (queue item id, task id, job id etc) + description: DEPRECATED. item Id (queue item id, task id, job id etc) format: int64 + x-deprecated: true Timer: type: string description: Resume timer (for time trigger) @@ -30103,7 +30107,9 @@ components: properties: HostLicenseId: type: integer + description: 'DEPRECATED. ' format: int64 + x-deprecated: true Id: type: integer description: License Id @@ -30564,20 +30570,6 @@ components: type: integer format: int64 description: "Logs generated by Robots and execution reports. Can be stored in ElasticSearch and/or to a local SQL database.\r\nNote: The endpoint for this type is /odata/RobotLogs URL." - LoginModel: - required: - - password - - usernameOrEmailAddress - type: object - properties: - tenancyName: - type: string - usernameOrEmailAddress: - minLength: 1 - type: string - password: - minLength: 1 - type: string LongVersionedEntity: type: object properties: @@ -31772,6 +31764,20 @@ components: type: array items: $ref: '#/components/schemas/BulkItemDtoOfString' + ODataValueOfIEnumerableOfBusinessRuleDto: + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/BusinessRuleDto' + ODataValueOfIEnumerableOfBusinessRuleVersionDto: + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/BusinessRuleVersionDto' ODataValueOfIEnumerableOfConfigurationEntry: type: object properties: @@ -31842,13 +31848,6 @@ components: type: array items: $ref: '#/components/schemas/FolderDto' - ODataValueOfIEnumerableOfHostLicenseDto: - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/HostLicenseDto' ODataValueOfIEnumerableOfInt64: type: object properties: @@ -32357,6 +32356,16 @@ components: format: date-time eventSource: type: object + PageResultDtoOfCurrentUserFolderDto: + type: object + properties: + PageItems: + type: array + items: + $ref: '#/components/schemas/CurrentUserFolderDto' + Count: + type: integer + format: int32 PageResultDtoOfPathAwareFolderDto: type: object properties: @@ -33430,8 +33439,12 @@ components: type: boolean AlwaysRunning: type: boolean + AutopilotForRobots: + $ref: '#/components/schemas/AutopilotForRobotsSettingsDto' EnableAutopilotHealing: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true ProcessesSetArgumentsRequest: required: - arguments @@ -33497,6 +33510,12 @@ components: description: The queue that triggered the event items: $ref: '#/components/schemas/QueueDefinitionEventDto' + FolderKeys: + type: array + description: The list of keys of the folders in which the queue is shared + items: + type: string + format: uuid EventTime: type: string format: date-time @@ -33658,6 +33677,27 @@ components: description: An integer value representing the Queue RiskSla in minutes. format: int32 readOnly: true + Tags: + type: array + description: Tags associated with the queue + readOnly: true + items: + $ref: '#/components/schemas/TagDto' + ReleaseKey: + type: string + description: Key of the release associated with the queue + format: uuid + readOnly: true + RetentionBucketKey: + type: string + description: Key of the retention bucket if retentionSettings are set for the queue + format: uuid + readOnly: true + StaleRetentionBucketKey: + type: string + description: Key of the retention bucket if retentionSettings are set for the queue + format: uuid + readOnly: true description: The definition of a work queue. A work queue contains work items that are processed by robots. QueueDeletedEventDto: required: @@ -33684,6 +33724,12 @@ components: description: The queue that triggered the event items: $ref: '#/components/schemas/QueueDefinitionEventDto' + FolderKeys: + type: array + description: The list of keys of the folders in which the queue is shared + items: + type: string + format: uuid EventTime: type: string format: date-time @@ -34755,6 +34801,14 @@ components: BucketId: type: integer format: int64 + Type: + type: string + enum: + - Final + - Stale + x-ms-enum: + name: BaseRetentionSettingDtoType + modelAsString: false QueueSetItemReviewStatusRequest: required: - queueItems @@ -34827,6 +34881,12 @@ components: description: The queue that triggered the event items: $ref: '#/components/schemas/QueueDefinitionEventDto' + FolderKeys: + type: array + description: The list of keys of the folders in which the queue is shared + items: + type: string + format: uuid EventTime: type: string format: date-time @@ -35196,6 +35256,14 @@ components: BucketId: type: integer format: int64 + Type: + type: string + enum: + - Final + - Stale + x-ms-enum: + name: BaseRetentionSettingDtoType + modelAsString: false ReleaseUpdatedEventDto: required: - EventId @@ -35414,6 +35482,8 @@ components: format: int64 enableAutopilotHealing: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true ResumeJobRequest: required: - jobKey @@ -35422,77 +35492,6 @@ components: jobKey: type: string format: uuid - RobotAssetDto: - required: - - Name - type: object - properties: - Name: - maxLength: 128 - minLength: 1 - type: string - description: The asset name. - ValueType: - type: string - description: Defines the type of value stored by the asset. - enum: - - DBConnectionString - - HttpConnectionString - - Text - - Bool - - Integer - - Credential - - WindowsCredential - - KeyValueList - x-enum-varnames: - - DBConnectionString - - HttpConnectionString - - Text - - Bool - - Integer - - Credential - - WindowsCredential - - KeyValueList - x-ms-enum: - name: RobotAssetDtoValueType - modelAsString: false - StringValue: - maxLength: 1000000 - type: string - description: The value of the asset when the value type is Text. Empty when the value type is not Text. - BoolValue: - type: boolean - description: The value of the asset when the value type is Bool. False when the value type is not Bool. - IntValue: - type: integer - description: The value of the asset when the value type is Integer. 0 when the value type is not Integer. - format: int32 - CredentialUsername: - type: string - description: The user name when the value type is Credential. Empty when the value type is not Credential. - CredentialPassword: - type: string - description: The password when the value type is Credential. Empty when the value type is not Credential. - ExternalName: - maxLength: 450 - minLength: 0 - type: string - description: Contains the value of the key in the external store used to store the credentials. - CredentialStoreId: - type: integer - description: The Credential Store used to store the credentials. - format: int64 - KeyValueList: - type: array - description: A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList. - items: - $ref: '#/components/schemas/CustomKeyValuePair' - ConnectionData: - $ref: '#/components/schemas/CredentialsConnectionData' - Id: - type: integer - format: int64 - description: A robot asset stores the information of a per robot asset for a specific robot, without specifying the robot. RobotCreatedEventDto: required: - EventId @@ -36767,6 +36766,7 @@ components: - RobotAPI - CommandLine - RobotNetAPI + - Autopilot x-ms-enum: name: SimpleJobEventDtoSourceType modelAsString: false @@ -37621,6 +37621,7 @@ components: - Assistant - CommandLine - RobotNetAPI + - Autopilot x-enum-varnames: - Manual - Schedule @@ -37637,6 +37638,7 @@ components: - Assistant - CommandLine - RobotNetAPI + - Autopilot x-ms-enum: name: StartProcessDtoSource modelAsString: false @@ -37747,8 +37749,16 @@ components: minLength: 0 type: string description: Operation id which started the job. + AutopilotForRobots: + $ref: '#/components/schemas/AutopilotForRobotsSettingsDto' EnableAutopilotHealing: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true + ProfilingOptions: + maxLength: 4000 + minLength: 0 + type: string description: The Start Process transfers information from client to the server during JobsController.StartJobs custom action. StopJobRequest: required: @@ -37954,6 +37964,110 @@ components: type: string description: Gets or sets the UserName or Email for this task assignment. If UserId is provided, this property is ignored. description: Class to hold assignment request details of a task. + TaskCatalogCreatedEvent: + type: object + properties: + key: + type: string + format: uuid + readOnly: true + name: + type: string + readOnly: true + description: + type: string + readOnly: true + foldersCount: + type: integer + format: int32 + readOnly: true + encrypted: + type: boolean + readOnly: true + retentionAction: + type: string + readOnly: true + enum: + - Delete + - Archive + - None + x-ms-enum: + name: TaskCatalogCreatedEventRetentionAction + modelAsString: false + retentionPeriod: + type: integer + format: int32 + readOnly: true + retentionBucketName: + type: string + readOnly: true + tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object + TaskCatalogDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + readOnly: true + name: + type: string + readOnly: true + description: + type: string + readOnly: true + foldersCount: + type: integer + format: int32 + readOnly: true + encrypted: + type: boolean + readOnly: true + retentionAction: + type: string + readOnly: true + enum: + - Delete + - Archive + - None + x-ms-enum: + name: TaskCatalogDeletedEventRetentionAction + modelAsString: false + retentionPeriod: + type: integer + format: int32 + readOnly: true + retentionBucketName: + type: string + readOnly: true + tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object TaskCatalogDto: type: object properties: @@ -38083,6 +38197,58 @@ components: description: Retention bucket Id format: int64 description: Task Catalog entity for Creating or Updating Task Catalog + TaskCatalogUpdatedEvent: + type: object + properties: + key: + type: string + format: uuid + readOnly: true + name: + type: string + readOnly: true + description: + type: string + readOnly: true + foldersCount: + type: integer + format: int32 + readOnly: true + encrypted: + type: boolean + readOnly: true + retentionAction: + type: string + readOnly: true + enum: + - Delete + - Archive + - None + x-ms-enum: + name: TaskCatalogUpdatedEventRetentionAction + modelAsString: false + retentionPeriod: + type: integer + format: int32 + readOnly: true + retentionBucketName: + type: string + readOnly: true + tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object TaskCompletedEventDto: required: - EventId @@ -39049,6 +39215,14 @@ components: BucketId: type: integer format: int64 + Type: + type: string + enum: + - Final + - Stale + x-ms-enum: + name: BaseRetentionSettingDtoType + modelAsString: false TaskSaveAndReassignmentRequest: type: object properties: @@ -39426,8 +39600,9 @@ components: properties: HostLicenseId: type: integer - description: The host license Id. + description: DEPRECATED. The host license Id. format: int64 + x-deprecated: true CreationTime: type: string description: The date it was uploaded. @@ -40361,6 +40536,19 @@ components: type: string description: The operation id which finished the queue item. Will be saved only if queue item is in final state description: Stores data sent when processing an item ended. + UiBlobFileAccessUri: + type: object + properties: + uri: + type: string + verb: + type: string + requiresAuth: + type: boolean + headers: + type: object + additionalProperties: + type: string UnattendedRobotDto: type: object properties: @@ -40512,6 +40700,76 @@ components: properties: setting: $ref: '#/components/schemas/SettingsDto' + UserAssetDto: + required: + - Name + type: object + properties: + Name: + maxLength: 128 + minLength: 1 + type: string + description: The asset name. + ValueType: + type: string + description: Defines the type of value stored by the asset. + enum: + - DBConnectionString + - HttpConnectionString + - Text + - Bool + - Integer + - Credential + - WindowsCredential + - KeyValueList + x-enum-varnames: + - DBConnectionString + - HttpConnectionString + - Text + - Bool + - Integer + - Credential + - WindowsCredential + - KeyValueList + x-ms-enum: + name: UserAssetDtoValueType + modelAsString: false + StringValue: + maxLength: 1000000 + type: string + description: The value of the asset when the value type is Text. Empty when the value type is not Text. + BoolValue: + type: boolean + description: The value of the asset when the value type is Bool. False when the value type is not Bool. + IntValue: + type: integer + description: The value of the asset when the value type is Integer. 0 when the value type is not Integer. + format: int32 + CredentialUsername: + type: string + description: The user name when the value type is Credential. Empty when the value type is not Credential. + CredentialPassword: + type: string + description: The password when the value type is Credential. Empty when the value type is not Credential. + ExternalName: + maxLength: 450 + minLength: 0 + type: string + description: Contains the value of the key in the external store used to store the credentials. + CredentialStoreId: + type: integer + description: The Credential Store used to store the credentials. + format: int64 + KeyValueList: + type: array + description: A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList. + items: + $ref: '#/components/schemas/CustomKeyValuePair' + ConnectionData: + $ref: '#/components/schemas/CredentialsConnectionData' + Id: + type: integer + format: int64 UserAssignRolesRequest: required: - roleIds @@ -40850,6 +41108,10 @@ components: type: boolean description: 'DEPRECATED. ' x-deprecated: true + AutopilotForRobotsDetectedIssues: + type: boolean + description: 'DEPRECATED. ' + x-deprecated: true UserOrganizationUnitDto: type: object properties: @@ -40982,15 +41244,6 @@ components: properties: processSchedule: $ref: '#/components/schemas/ProcessScheduleDto' - ValidationErrorInfo: - type: object - properties: - message: - type: string - members: - type: array - items: - type: string ValidationResultDto: type: object properties: @@ -41615,6 +41868,7 @@ components: - RobotAPI - CommandLine - RobotNetAPI + - Autopilot x-enum-varnames: - Manual - Schedule @@ -41631,6 +41885,7 @@ components: - RobotAPI - CommandLine - RobotNetAPI + - Autopilot x-ms-enum: name: WrappedJobDtoSourceType modelAsString: false @@ -42103,6 +42358,7 @@ components: - Assistant - CommandLine - RobotNetAPI + - Autopilot x-enum-varnames: - Manual - Schedule @@ -42119,6 +42375,7 @@ components: - Assistant - CommandLine - RobotNetAPI + - Autopilot x-ms-enum: name: WrappedStartProcessDtoSource modelAsString: false diff --git a/parser/definition.go b/parser/definition.go index 4c62b86..73a53a6 100644 --- a/parser/definition.go +++ b/parser/definition.go @@ -3,10 +3,11 @@ package parser // The Definition provides the high-level information about all operations of the service type Definition struct { Name string + Summary string Description string Operations []Operation } -func NewDefinition(name string, description string, operations []Operation) *Definition { - return &Definition{name, description, operations} +func NewDefinition(name string, summary string, description string, operations []Operation) *Definition { + return &Definition{name, summary, description, operations} } diff --git a/parser/description_provider.go b/parser/description_provider.go new file mode 100644 index 0000000..f2fae05 --- /dev/null +++ b/parser/description_provider.go @@ -0,0 +1,102 @@ +package parser + +var descriptions = map[string]*descriptionInfo{ + "du": newDescriptionInfo("Document Understanding", "Document Understanding uses a combination of robotic process automation (RPA) and AI to automatically process your documents."), + "du classification": newDescriptionInfo("Document classification", "Document Classification is a component that helps in identifying what types of files the robot is processing."), + "du digitization": newDescriptionInfo("Document digitization", "Digitization is the process of obtaining machine readable text from a given incoming file, so that a robot can then understand its contents and act upon them."), + "du discovery": newDescriptionInfo("Resource discovery", "Using the Discovery Service for retrieving information about the newly created project and its resources."), + "du extraction": newDescriptionInfo("Data extraction", "Data Extraction is a component that helps in identifying very specific information that you are interested in, from your document types."), + "du validation": newDescriptionInfo("Data validation", "Validation is an optional step which refers to a human review step, in which knowledge workers can review the results and correct them when necessary."), + "identity": newDescriptionInfo("Identity Server", "Service that offers centralized authentication and access control across UiPath products."), + "identity audit-query": newDescriptionInfo("Inspect audit events", "As an organization admin, use these endpoints to list and download audit events."), + "identity group": newDescriptionInfo("Manage groups in your organization", "Use these endpoints to manage groups in your organization."), + "identity message-template": newDescriptionInfo("Create message Templates", "Manage your message templates."), + "identity robot-account": newDescriptionInfo("Manage robot accounts", "Use these endpoints to manage robot accounts."), + "identity setting": newDescriptionInfo("Update application settings", "Manage your application settings."), + "identity token": newDescriptionInfo("Access tokens", "Endpoint to retrieve short-lived access tokens."), + "identity user": newDescriptionInfo("Manage local users", "Use these endpoints to manage local users."), + "identity user-login-attempt": newDescriptionInfo("Inspect user login attempts", "Review login attempts of your users."), + "orchestrator": newDescriptionInfo("UiPath Orchestrator", "Orchestrator gives you the power you need to provision, deploy, trigger, monitor, measure, and track the work of attended and unattended robots."), + "orchestrator alerts": newDescriptionInfo("Notifications for system events", "Alerts are notifications related to robots, queue items, triggers, and more."), + "orchestrator app-tasks": newDescriptionInfo("Tasks executed within Orchestrator apps", "App Tasks are activities and assignments that need human intervention in a robotic process automation (RPA) workflow."), + "orchestrator assets": newDescriptionInfo("Shared, reusable workflow values/components", "Assets usually represent shared variables or credentials that can be used in different automation projects. They allow you to store specific information so that the Robots can easily access it."), + "orchestrator audit-logs": newDescriptionInfo("Recorded activity for audit purposes", "Logs help with debugging issues, increasing security and performance, or reporting trends."), + "orchestrator buckets": newDescriptionInfo("Designated storage in Orchestrator", "Buckets provide a per-folder storage solution for RPA developers to leverage in creating automation projects."), + "orchestrator business-rules": newDescriptionInfo("Policies governing system processes", "Business rules are predefined instructions or conditions that determine how a process or task should be carried out."), + "orchestrator calendars": newDescriptionInfo("Framework for scheduling tasks", "Calendars allow users to fine-tune schedules for jobs in your automations."), + "orchestrator credential-stores": newDescriptionInfo("Secure storage for access credentials", "Secure location where you can store sensitive data."), + "orchestrator directory-service": newDescriptionInfo("User/group organizational system", "Integration of Orchestrator with an organization's directory service to manage users and group membership."), + "orchestrator environments": newDescriptionInfo("Unique process and robot groupings", "Environments represent a logical grouping of Robots that have common characteristics or purposes."), + "orchestrator execution-media": newDescriptionInfo("Media from a process run", "Storing screenshots of RPA executions, so that developers, administrators, or process stakeholders could see what actions a robot took during execution."), + "orchestrator exports": newDescriptionInfo("Data exported from Orchestrator", "Extract and download data into a file that you can use for reporting, analysis, or for backup and archival purposes."), + "orchestrator folders": newDescriptionInfo("Organizational structure for Orchestrator resources", "Folders are organizational units within Orchestrator that help manage and organize resources such as Robots, Processes, Queues, Assets, and more."), + "orchestrator folders-navigation": newDescriptionInfo("Hierarchical traversal through folders", "Allows users to manage and organize resources effectively, including Robots, Processes, Queues, and Assets."), + "orchestrator generic-tasks": newDescriptionInfo("Basic, undefined task types", "Manage basic unit of work assigned by a process or a robot."), + "orchestrator job-triggers": newDescriptionInfo("Initiators of Orchestrator jobs", "Triggers are used to schedule the execution of processes."), + "orchestrator jobs": newDescriptionInfo("Specific instances of process execution", "Job represent an execution of a process on the UiPath Robots."), + "orchestrator libraries": newDescriptionInfo("Repositories for reusable components", "Manage reusable components used in automation workflows."), + "orchestrator licenses-named-user": newDescriptionInfo("User-specific Orchestrator licenses", "Licenses granted to a specific user in the system, typically identified by their username."), + "orchestrator licenses-runtime": newDescriptionInfo("Licenses for robot runtime capacity", "A runtime license refers to a licensing model where the license is granted to an Unattended Robot per run."), + "orchestrator licensing": newDescriptionInfo("License units", "APIs to aquire and release license units."), + "orchestrator logs": newDescriptionInfo("Recorded activities and events", "Records of the activities and events that occur during the execution of a process."), + "orchestrator machines": newDescriptionInfo("Managed hosts for robots", "Physical or virtual machine (computer) where to deploy a UiPath Robot for executing automation processes."), + "orchestrator maintenance": newDescriptionInfo("Maintenance mode", "Maintenance Mode provides a simplified and pain-free solution for stopping all Orchestrator activity."), + "orchestrator organization-units": newDescriptionInfo("Divisions for resource management", "Entities that can have their own separate Robots, Processes, Assets, Queues, etc.."), + "orchestrator package-feeds": newDescriptionInfo("Packages management", "Package feeds represent the sources where the automation packages or processes developed in UiPath Studio are stored so they can be distributed and run on Robots."), + "orchestrator permissions": newDescriptionInfo("Access rights", "Permissions define the level of access a user has within the system. They are used to control which features and resources (like Robots, Processes, Jobs, Queues, etc.) a user can view, edit, or manage."), + "orchestrator personal-workspaces": newDescriptionInfo("Individual work areas", "Every user can have a personal workspace in Orchestrator where they can publish, test, and run their processes. Personal workspaces serve as a staging or development area for users to refine their automation before moving it to a shared workspace or production."), + "orchestrator process-schedules": newDescriptionInfo("Planned schedules for process execution", "Process Schedules allow you to automate when your processes or jobs are run, without having to manually start them each time."), + "orchestrator processes": newDescriptionInfo("Workflows for execution", "Processes refer to the actual automations or workflows developed using UiPath Studio that are to be executed by the Robots."), + "orchestrator queue-definitions": newDescriptionInfo("Descriptions for types of queues", "Queue definitions are used to define and configure the queues that are used in Robotic Process Automation (RPA) workflows."), + "orchestrator queue-item-comments": newDescriptionInfo("Notes or details for queue items", "Add comments or notes to a specific queue item."), + "orchestrator queue-item-events": newDescriptionInfo("Occurrences related to queue items", "Events are triggered when the status of a queue item changes, such as when it is added, started, failed, successful etc."), + "orchestrator queue-items": newDescriptionInfo("Data units processed by Robots", "Queue items are data units that are to be processed by Robots in automation workflows."), + "orchestrator queue-processing-records": newDescriptionInfo("Progress records of queue items", "Progress of processing queue items, including status updates and reasons for failure."), + "orchestrator queue-retention": newDescriptionInfo("Rules for storing queue data", "Queue retention defines how long the processed queue item data is stored before it is deleted."), + "orchestrator queues": newDescriptionInfo("Storage for multiple work items", "Queues are used to store multiple items that need to be processed by robots."), + "orchestrator release-retention": newDescriptionInfo("Rules for retaining release information", "Release retention define the rules for how long the information about a release is retained in Orchestrator's storage."), + "orchestrator releases": newDescriptionInfo("Packages prepared for Robot execution", "Releases represent the processes or packages that are prepared for execution on robots."), + "orchestrator robot-logs": newDescriptionInfo("Records of robot events", "Robot Logs are records of the different actions and events tracked during a robot's operation."), + "orchestrator robots": newDescriptionInfo("Entities executing automation processes", "Robots are the entities that execute the automation processes."), + "orchestrator roles": newDescriptionInfo("User permissions management system", "Roles allow users to assign and manage different permissions to users or groups."), + "orchestrator sessions": newDescriptionInfo("Instance of Robot execution", "Sessions represent an instance of a robot's execution of a process."), + "orchestrator settings": newDescriptionInfo("Operation configurations", "Settings define the configurations for various aspects of Orchestrator's operation."), + "orchestrator stats": newDescriptionInfo("Performance metrics", "Stats provide analytics and metrics about the performance and usage of robots and processes."), + "orchestrator status": newDescriptionInfo("Current orchestrator status", "Status represents the current state or progress of various components like jobs, robots, or queue items."), + "orchestrator task-activities": newDescriptionInfo("Actions comprising a task", "Task Activities are the individual actions or steps that make up a task workflow."), + "orchestrator task-catalogs": newDescriptionInfo("Collections of business task definitions", "Task Catalogs are organized collections of task definitions for various business processes."), + "orchestrator task-definitions": newDescriptionInfo("Settings of a task", "Task Definitions describe the properties and settings of a task."), + "orchestrator task-forms": newDescriptionInfo("UI for human-robot collaboration tasks", "Task Forms are custom UI interfaces created for human-robot collaboration tasks."), + "orchestrator task-notes": newDescriptionInfo("Additional details for tasks", "Task Notes are additional context or details added to tasks."), + "orchestrator task-retention": newDescriptionInfo("Rules for retaining task data", "Task Retention is a set of rules that control how long task data is kept before being deleted."), + "orchestrator tasks": newDescriptionInfo("Actions to be completed", "Tasks are actions to be completed in a business process, they may be attended (requires human interaction) or unattended."), + "orchestrator tenants": newDescriptionInfo("Independent spaces isolating data", "Tenants are independent spaces where you can isolate data, with its own robots, processes and users."), + "orchestrator test-automation": newDescriptionInfo("Management and execution of tests", "Test Automation is a feature that allows you to plan, manage, and run your automated tests."), + "orchestrator test-case-definitions": newDescriptionInfo("Specifications for running test cases", "Test Case Definitions are the specifications for how a test case is to be run."), + "orchestrator test-case-executions": newDescriptionInfo("Instances of tests running", "Test Case Executions are instances of a test case running on a Robot."), + "orchestrator test-data-queue-actions": newDescriptionInfo("Operations for managing test data", "Test Data Queue Actions provide operations for managing data in Test Data Queues."), + "orchestrator test-data-queue-items": newDescriptionInfo("Units of test data", "Test Data Queue Items are individual units of test data stored in a Test Data Queue."), + "orchestrator test-data-queues": newDescriptionInfo("Storage for test data", "Test Data Queues are used to store test data for consumption in Test Cases."), + "orchestrator test-set-executions": newDescriptionInfo("Instances of test sets running", "Test Set Executions are instances of a set of Test Cases running on a Robot."), + "orchestrator test-set-schedules": newDescriptionInfo("Rules for automatic test runs", "Test Set Schedules define when a Test Set is automatically run on a Robot."), + "orchestrator test-sets": newDescriptionInfo("Groups of test cases", "Test Sets are groups of Test Cases that are set to run together."), + "orchestrator translations": newDescriptionInfo("Translation resources", "Translations resources to provide multilingual UI."), + "orchestrator users": newDescriptionInfo("Manage Users", "Users are individuals who have access to the Orchestrator's features."), + "orchestrator webhooks": newDescriptionInfo("Notifications of changes", "Webhooks enable real-time notifications about changes or updates in Orchestrator to other applications through HTTP POST request."), +} + +func LookupDescription(name string) *descriptionInfo { + if result, found := descriptions[name]; found { + return result + } + return nil +} + +type descriptionInfo struct { + Summary string + Description string +} + +func newDescriptionInfo(summary string, description string) *descriptionInfo { + return &descriptionInfo{summary, description} +} diff --git a/parser/openapi_parser.go b/parser/openapi_parser.go index c3ad069..cd4871f 100644 --- a/parser/openapi_parser.go +++ b/parser/openapi_parser.go @@ -17,6 +17,16 @@ const CustomNameExtension = "x-uipathcli-name" // operations and their parameters for the given service specification. type OpenApiParser struct{} +func (p OpenApiParser) getSummary(extensions map[string]interface{}) string { + name := extensions["summary"] + switch v := name.(type) { + case string: + return v + default: + return "" + } +} + func (p OpenApiParser) getCustomName(extensions map[string]interface{}) string { name := extensions[CustomNameExtension] switch v := name.(type) { @@ -36,16 +46,39 @@ func (p OpenApiParser) contains(strs []string, str string) bool { return false } -func (p OpenApiParser) getDescription(document openapi3.T) string { +func (p OpenApiParser) getDocumentSummary(document openapi3.T) string { if document.Info == nil { return "" } - if document.Info.Description != "" { - return document.Info.Description - } return document.Info.Title } +func (p OpenApiParser) getDocumentDescription(document openapi3.T) string { + if document.Info == nil { + return "" + } + return document.Info.Description +} + +func (p OpenApiParser) getDocumentText(name string, document openapi3.T) (string, string) { + result := LookupDescription(name) + if result != nil { + return result.Summary, result.Description + } + return p.getDocumentSummary(document), p.getDocumentDescription(document) +} + +func (p OpenApiParser) getCategoryText(definitionName string, name string, tag *openapi3.Tag) (string, string) { + result := LookupDescription(definitionName + " " + name) + if result != nil { + return result.Summary, result.Description + } + if tag != nil { + return p.getSummary(tag.Extensions), tag.Description + } + return "", "" +} + func (p OpenApiParser) getUri(document openapi3.T) (*url.URL, error) { server := DefaultServerBaseUrl if len(document.Servers) > 0 { @@ -283,47 +316,46 @@ func (p OpenApiParser) parseOperationParameters(operation openapi3.Operation, ro return contentType, append(parameters, p.parseParameters(operation.Parameters)...) } -func (p OpenApiParser) getCategory(operation openapi3.Operation, document openapi3.T) *OperationCategory { +func (p OpenApiParser) getCategory(definitionName string, document openapi3.T, operation openapi3.Operation) *OperationCategory { if len(operation.Tags) > 0 { name := operation.Tags[0] - description := "" tag := document.Tags.Get(name) - if tag != nil { - description = tag.Description - } - return NewOperationCategory(p.formatName(name), description) + formattedName := p.formatName(name) + summary, description := p.getCategoryText(definitionName, formattedName, tag) + return NewOperationCategory(formattedName, summary, description) } return nil } -func (p OpenApiParser) parseOperation(method string, baseUri url.URL, route string, operation openapi3.Operation, routeParameters openapi3.Parameters, document openapi3.T) Operation { - category := p.getCategory(operation, document) +func (p OpenApiParser) parseOperation(definitionName string, document openapi3.T, method string, baseUri url.URL, route string, operation openapi3.Operation, routeParameters openapi3.Parameters) Operation { + category := p.getCategory(definitionName, document, operation) name := p.getOperationName(method, route, category, operation) contentType, parameters := p.parseOperationParameters(operation, routeParameters) return *NewOperation(name, operation.Summary, operation.Description, method, baseUri, route, contentType, parameters, nil, false, category) } -func (p OpenApiParser) parsePath(baseUri url.URL, route string, pathItem openapi3.PathItem, document openapi3.T) []Operation { +func (p OpenApiParser) parsePath(definitionName string, document openapi3.T, baseUri url.URL, route string, pathItem openapi3.PathItem) []Operation { operations := []Operation{} for method := range pathItem.Operations() { operation := pathItem.GetOperation(method) - operations = append(operations, p.parseOperation(method, baseUri, route, *operation, pathItem.Parameters, document)) + operations = append(operations, p.parseOperation(definitionName, document, method, baseUri, route, *operation, pathItem.Parameters)) } return operations } -func (p OpenApiParser) parse(name string, document openapi3.T) (*Definition, error) { +func (p OpenApiParser) parse(definitionName string, document openapi3.T) (*Definition, error) { uri, err := p.getUri(document) if err != nil { return nil, fmt.Errorf("Error parsing server URL: %w", err) } + formattedName := strings.Split(definitionName, ".")[0] operations := []Operation{} for path := range document.Paths.Map() { pathItem := document.Paths.Find(path) - operations = append(operations, p.parsePath(*uri, path, *pathItem, document)...) + operations = append(operations, p.parsePath(formattedName, document, *uri, path, *pathItem)...) } - description := p.getDescription(document) - return NewDefinition(name, description, operations), nil + summary, description := p.getDocumentText(formattedName, document) + return NewDefinition(definitionName, summary, description, operations), nil } func (p OpenApiParser) Parse(name string, data []byte) (*Definition, error) { diff --git a/parser/operation_category.go b/parser/operation_category.go index 5f679a1..5b288a6 100644 --- a/parser/operation_category.go +++ b/parser/operation_category.go @@ -3,9 +3,10 @@ package parser // OperationCategory allows grouping multiple operations under a common resource. type OperationCategory struct { Name string + Summary string Description string } -func NewOperationCategory(name string, description string) *OperationCategory { - return &OperationCategory{name, description} +func NewOperationCategory(name string, summary string, description string) *OperationCategory { + return &OperationCategory{name, summary, description} } diff --git a/plugin/command.go b/plugin/command.go index 76bee41..01d1d19 100644 --- a/plugin/command.go +++ b/plugin/command.go @@ -6,19 +6,21 @@ package plugin type Command struct { Service string Name string + Summary string Description string Parameters []CommandParameter Hidden bool Category *CommandCategory } -func (c *Command) WithCategory(name string, description string) *Command { - c.Category = NewCommandCategory(name, description) +func (c *Command) WithCategory(name string, summary string, description string) *Command { + c.Category = NewCommandCategory(name, summary, description) return c } -func (c *Command) WithOperation(name string, description string) *Command { +func (c *Command) WithOperation(name string, summary string, description string) *Command { c.Name = name + c.Summary = summary c.Description = description return c } diff --git a/plugin/command_category.go b/plugin/command_category.go index 7eef01d..f13e3f7 100644 --- a/plugin/command_category.go +++ b/plugin/command_category.go @@ -6,9 +6,10 @@ package plugin // uipath service category operation --parameter my-value type CommandCategory struct { Name string + Summary string Description string } -func NewCommandCategory(name string, description string) *CommandCategory { - return &CommandCategory{name, description} +func NewCommandCategory(name string, summary string, description string) *CommandCategory { + return &CommandCategory{name, summary, description} } diff --git a/plugin/command_test.go b/plugin/command_test.go index 4321869..fa50618 100644 --- a/plugin/command_test.go +++ b/plugin/command_test.go @@ -6,8 +6,8 @@ import ( func TestCommand(t *testing.T) { command := NewCommand("my-service"). - WithCategory("my-category", "category description"). - WithOperation("my-operation", "operation description"). + WithCategory("my-category", "category summary", "category description"). + WithOperation("my-operation", "operation summary", "operation description"). IsHidden() if command.Service != "my-service" { @@ -16,12 +16,18 @@ func TestCommand(t *testing.T) { if command.Category.Name != "my-category" { t.Errorf("Did not return category name, but got: %v", command.Category.Name) } + if command.Category.Summary != "category summary" { + t.Errorf("Did not return category summary, but got: %v", command.Category.Summary) + } if command.Category.Description != "category description" { t.Errorf("Did not return category description, but got: %v", command.Category.Description) } if command.Name != "my-operation" { t.Errorf("Did not return operation name, but got: %v", command.Name) } + if command.Summary != "operation summary" { + t.Errorf("Did not return operation summary, but got: %v", command.Summary) + } if command.Description != "operation description" { t.Errorf("Did not return operation description, but got: %v", command.Description) } diff --git a/plugin/digitizer/digitize_command.go b/plugin/digitizer/digitize_command.go index b8c6d41..958b91b 100644 --- a/plugin/digitizer/digitize_command.go +++ b/plugin/digitizer/digitize_command.go @@ -26,8 +26,8 @@ type DigitizeCommand struct{} func (c DigitizeCommand) Command() plugin.Command { return *plugin.NewCommand("du"). - WithCategory("digitization", "Document Digitization"). - WithOperation("digitize", "Digitize the given file"). + WithCategory("digitization", "Document Digitization", "Digitizes a document, extracting its Document Object Model (DOM) and text."). + WithOperation("digitize", "Digitize file", "Digitize the given file"). WithParameter("project-id", plugin.ParameterTypeString, "The project id", true). WithParameter("file", plugin.ParameterTypeBinary, "The file to digitize", true). WithParameter("content-type", plugin.ParameterTypeString, "The content type", false) diff --git a/plugin/orchestrator/download_command.go b/plugin/orchestrator/download_command.go index 63bbabb..c0dfb6c 100644 --- a/plugin/orchestrator/download_command.go +++ b/plugin/orchestrator/download_command.go @@ -24,8 +24,8 @@ type DownloadCommand struct{} func (c DownloadCommand) Command() plugin.Command { return *plugin.NewCommand("orchestrator"). - WithCategory("buckets", "Orchestrator Buckets"). - WithOperation("download", "Downloads the file with the given path from the bucket"). + WithCategory("buckets", "Orchestrator Buckets", "Buckets provide a per-folder storage solution for RPA developers to leverage in creating automation projects."). + WithOperation("download", "Download file", "Downloads the file with the given path from the bucket"). WithParameter("folder-id", plugin.ParameterTypeInteger, "Folder/OrganizationUnit Id", true). WithParameter("key", plugin.ParameterTypeInteger, "The Bucket Id", true). WithParameter("path", plugin.ParameterTypeString, "The BlobFile full path", true) diff --git a/plugin/orchestrator/upload_command.go b/plugin/orchestrator/upload_command.go index 47d7cc0..10f587b 100644 --- a/plugin/orchestrator/upload_command.go +++ b/plugin/orchestrator/upload_command.go @@ -24,8 +24,8 @@ type UploadCommand struct{} func (c UploadCommand) Command() plugin.Command { return *plugin.NewCommand("orchestrator"). - WithCategory("buckets", "Orchestrator Buckets"). - WithOperation("upload", "Uploads the provided file to the bucket"). + WithCategory("buckets", "Orchestrator Buckets", "Buckets provide a per-folder storage solution for RPA developers to leverage in creating automation projects."). + WithOperation("upload", "Upload file", "Uploads the provided file to the bucket"). WithParameter("folder-id", plugin.ParameterTypeInteger, "Folder/OrganizationUnit Id", true). WithParameter("key", plugin.ParameterTypeInteger, "The Bucket Id", true). WithParameter("path", plugin.ParameterTypeString, "The BlobFile full path", true). diff --git a/test/parser_test.go b/test/parser_test.go index 6c656ea..c282d28 100644 --- a/test/parser_test.go +++ b/test/parser_test.go @@ -56,6 +56,48 @@ info: } } +func TestOverridePredefinedServiceDescription(t *testing.T) { + context := NewContextBuilder(). + WithDefinition("orchestrator", ""). + Build() + + result := RunCli([]string{"orchestrator", "--help"}, context) + + expectedSummary := "UiPath Orchestrator" + if !strings.Contains(result.StdOut, expectedSummary) { + t.Errorf("stdout does not contain service summary, expected: %v, got: %v", expectedSummary, result.StdOut) + } + expectedDescription := "Orchestrator gives you the power you need to provision, deploy, trigger, monitor, measure, and track the work of attended and unattended robots." + if !strings.Contains(result.StdOut, expectedDescription) { + t.Errorf("stdout does not contain service description, expected: %v, got: %v", expectedDescription, result.StdOut) + } +} + +func TestOverridePredefinedCategoryDescription(t *testing.T) { + definition := ` +paths: + /digitize: + get: + tags: + - Digitization + summary: digitize +` + context := NewContextBuilder(). + WithDefinition("du", definition). + Build() + + result := RunCli([]string{"du", "digitization", "--help"}, context) + + expectedSummary := "Document digitization" + if !strings.Contains(result.StdOut, expectedSummary) { + t.Errorf("stdout does not contain service summary, expected: %v, got: %v", expectedSummary, result.StdOut) + } + expectedDescription := "Digitization is the process of obtaining machine readable text from a given incoming file, so that a robot can then understand its contents and act upon them." + if !strings.Contains(result.StdOut, expectedDescription) { + t.Errorf("stdout does not contain service description, expected: %v, got: %v", expectedDescription, result.StdOut) + } +} + func TestMultipleOperationsSortedByName(t *testing.T) { definition := ` paths: diff --git a/test/plugin_test.go b/test/plugin_test.go index 780904e..8727aef 100644 --- a/test/plugin_test.go +++ b/test/plugin_test.go @@ -280,7 +280,7 @@ type SimplePluginCommand struct{} func (c SimplePluginCommand) Command() plugin.Command { return *plugin.NewCommand("mypluginservice"). - WithOperation("my-plugin-command", "This is a simple plugin command") + WithOperation("my-plugin-command", "Simple Command", "This is a simple plugin command") } func (c SimplePluginCommand) Execute(context plugin.ExecutionContext, writer output.OutputWriter, logger log.Logger) error { @@ -294,7 +294,7 @@ type ContextPluginCommand struct { func (c ContextPluginCommand) Command() plugin.Command { return *plugin.NewCommand("mypluginservice"). - WithOperation("my-plugin-command", "This is a simple plugin command"). + WithOperation("my-plugin-command", "Simple Command", "This is a simple plugin command"). WithParameter("filter", plugin.ParameterTypeString, "This is a filter", false) } @@ -307,7 +307,7 @@ type ErrorPluginCommand struct{} func (c ErrorPluginCommand) Command() plugin.Command { return *plugin.NewCommand("mypluginservice"). - WithOperation("my-failed-command", "This command always fails") + WithOperation("my-failed-command", "Command fails", "This command always fails") } func (c ErrorPluginCommand) Execute(context plugin.ExecutionContext, writer output.OutputWriter, logger log.Logger) error { @@ -318,7 +318,7 @@ type HideOperationPluginCommand struct{} func (c HideOperationPluginCommand) Command() plugin.Command { return *plugin.NewCommand("mypluginservice"). - WithOperation("my-hidden-command", "This command should not be shown"). + WithOperation("my-hidden-command", "Hidden command", "This command should not be shown"). IsHidden() } @@ -330,7 +330,7 @@ type ParametrizedPluginCommand struct{} func (c ParametrizedPluginCommand) Command() plugin.Command { return *plugin.NewCommand("mypluginservice"). - WithOperation("my-parametrized-command", "This is a plugin command with parameters"). + WithOperation("my-parametrized-command", "Parametrized Command", "This is a plugin command with parameters"). WithParameter("take", plugin.ParameterTypeInteger, "This is a take parameter", true) }