From 51bdffb50df3b0a0128b5d15504f1054755f6de9 Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Tue, 23 Jan 2024 17:08:46 +0200 Subject: [PATCH] Update to latest OpenAPI definitions --- definitions/du.framework.yaml | 1518 ++++++++++++++++++++++++++++++++- definitions/identity.yaml | 444 +--------- definitions/orchestrator.yaml | 1200 +++++++++++++++++--------- 3 files changed, 2330 insertions(+), 832 deletions(-) diff --git a/definitions/du.framework.yaml b/definitions/du.framework.yaml index 8fd2078..d3a6322 100644 --- a/definitions/du.framework.yaml +++ b/definitions/du.framework.yaml @@ -1056,12 +1056,51 @@ paths: application/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: 9b2485ba-1d00-4622-b27e-d89badcb4330 + prompts: null + Generative Classification: + value: + documentId: 9b2485ba-1d00-4622-b27e-d89badcb4330 + prompts: + - name: Invoice + 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. text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: 9b2485ba-1d00-4622-b27e-d89badcb4330 + prompts: null + Generative Classification: + value: + documentId: 9b2485ba-1d00-4622-b27e-d89badcb4330 + prompts: + - name: Invoice + 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. application/*+json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: 9b2485ba-1d00-4622-b27e-d89badcb4330 + prompts: null + Generative Classification: + value: + documentId: 9b2485ba-1d00-4622-b27e-d89badcb4330 + prompts: + - name: Invoice + 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. responses: "200": description: Success @@ -1182,12 +1221,51 @@ paths: application/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: db31f981-0233-438e-9f49-7a6a6744ff3a + prompts: null + Generative Classification: + value: + documentId: db31f981-0233-438e-9f49-7a6a6744ff3a + prompts: + - name: Invoice + 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. text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: db31f981-0233-438e-9f49-7a6a6744ff3a + prompts: null + Generative Classification: + value: + documentId: db31f981-0233-438e-9f49-7a6a6744ff3a + prompts: + - name: Invoice + 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. application/*+json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: db31f981-0233-438e-9f49-7a6a6744ff3a + prompts: null + Generative Classification: + value: + documentId: db31f981-0233-438e-9f49-7a6a6744ff3a + prompts: + - name: Invoice + 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. responses: "202": description: Accepted @@ -1391,12 +1469,57 @@ paths: application/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 71b67f25-0eca-4a07-82dd-b4609be32d8e + prompts: null + Generative Extraction: + value: + documentId: 71b67f25-0eca-4a07-82dd-b4609be32d8e + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 71b67f25-0eca-4a07-82dd-b4609be32d8e + prompts: null + Generative Extraction: + value: + documentId: 71b67f25-0eca-4a07-82dd-b4609be32d8e + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. application/*+json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 71b67f25-0eca-4a07-82dd-b4609be32d8e + prompts: null + Generative Extraction: + value: + documentId: 71b67f25-0eca-4a07-82dd-b4609be32d8e + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. responses: "200": description: Success @@ -1529,12 +1652,57 @@ paths: application/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 950180c6-9c3b-4e39-a540-319da61832aa + prompts: null + Generative Extraction: + value: + documentId: 950180c6-9c3b-4e39-a540-319da61832aa + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 950180c6-9c3b-4e39-a540-319da61832aa + prompts: null + Generative Extraction: + value: + documentId: 950180c6-9c3b-4e39-a540-319da61832aa + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. application/*+json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 950180c6-9c3b-4e39-a540-319da61832aa + prompts: null + Generative Extraction: + value: + documentId: 950180c6-9c3b-4e39-a540-319da61832aa + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. responses: "202": description: Accepted @@ -1738,12 +1906,237 @@ paths: application/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + 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: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + 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: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket application/*+json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + 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: d8258623-7d0a-479c-8437-eb8b6cd68ca3 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket responses: "202": description: Accepted @@ -1983,12 +2376,1095 @@ paths: application/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartExtractionValidationTaskRequest' + examples: + Specialized Extraction Validation: + value: + extractionResult: + DocumentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: null + documentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Extraction Validation: + value: + extractionResult: + DocumentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + documentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartExtractionValidationTaskRequest' + examples: + Specialized Extraction Validation: + value: + extractionResult: + DocumentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: null + documentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Extraction Validation: + value: + extractionResult: + DocumentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + documentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket application/*+json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartExtractionValidationTaskRequest' + examples: + Specialized Extraction Validation: + value: + extractionResult: + DocumentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: null + documentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Extraction Validation: + value: + extractionResult: + DocumentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + documentId: 9a02e6bc-da67-4da3-92b9-c0ea9ca49ccd + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket responses: "202": description: Accepted @@ -2686,13 +4162,13 @@ components: - Expression - TableExpression type: string - UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.ActionStatus: + UiPath.DocumentUnderstanding.Common.Clients.Orchestrator.Model.ActionStatus: enum: - Unassigned - Pending - Completed type: string - UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.CreateTaskPriority: + UiPath.DocumentUnderstanding.Common.Clients.Orchestrator.Model.CreateTaskPriority: enum: - Low - Medium @@ -2707,6 +4183,11 @@ components: description: Id of the document obtained from the Digitization operation. format: uuid example: ID of the document obtained from the Digitization operation. + prompts: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ClassificationPrompt' + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse: type: object @@ -3133,6 +4614,11 @@ components: description: Id of the document obtained from the Digitization operation. format: uuid example: ID of the document obtained from the Digitization operation. + prompts: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ExtractionPrompt' + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult: type: object @@ -3193,7 +4679,7 @@ components: type: object properties: actionStatus: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.ActionStatus' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.Clients.Orchestrator.Model.ActionStatus' actionData: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Services.Model.DocumentClassificationActionDataModel' validatedClassificationResults: @@ -3207,7 +4693,7 @@ components: type: object properties: actionStatus: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.ActionStatus' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.Clients.Orchestrator.Model.ActionStatus' actionData: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Services.Model.DocumentExtractionActionDataModel' validatedExtractionResults: @@ -3282,7 +4768,7 @@ components: nullable: true example: Title of the action in action center actionPriority: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.CreateTaskPriority' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.Clients.Orchestrator.Model.CreateTaskPriority' actionCatalog: type: string description: The name of the catalog in which the action is created. @@ -3309,6 +4795,11 @@ components: $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Results.ClassificationResult' description: The Classification Result that requires validation nullable: true + prompts: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ClassificationPrompt' + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartExtractionValidationTaskRequest: type: object @@ -3325,7 +4816,7 @@ components: nullable: true example: Title of the action in action center actionPriority: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.CreateTaskPriority' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.Clients.Orchestrator.Model.CreateTaskPriority' actionCatalog: type: string description: The name of the catalog in which the action is created. @@ -3348,6 +4839,11 @@ components: example: du_storage_bucket extractionResult: $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Results.ExtractionResult' + prompts: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ExtractionPrompt' + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse: type: object @@ -3413,6 +4909,16 @@ components: type: string nullable: true additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ExtractionPrompt: + type: object + properties: + id: + type: string + nullable: true + question: + type: string + nullable: true + additionalProperties: false UiPath.DocumentUnderstanding.Framework.Validation.Services.Model.DocumentClassificationActionDataModel: type: object properties: diff --git a/definitions/identity.yaml b/definitions/identity.yaml index 165ce41..f8473a8 100644 --- a/definitions/identity.yaml +++ b/definitions/identity.yaml @@ -1,8 +1,8 @@ openapi: 3.0.1 info: title: IdentityServer External API - version: 3.0.3 - x-uipath-version: 3.0.3 + version: 3.0.10 + x-uipath-version: 3.0.10 servers: - url: https://cloud.uipath.com/identity_ paths: @@ -301,9 +301,9 @@ paths: type: string - name: top in: query - description: The number of records to return. Default is 10. + description: The number of records to return. Default is 10. Range is 0 to 1000. schema: - maximum: 2147483647 + maximum: 1000 minimum: 0 type: integer format: int32 @@ -447,229 +447,6 @@ paths: application/json: schema: $ref: '#/components/schemas/RobotAccountDto' - /scim/groups: - post: - tags: - - ScimGroups - summary: Creates a new scim group. - operationId: ScimGroups_CreateGroups - requestBody: - description: The data used to create a new group. - content: - application/json: - schema: - $ref: '#/components/schemas/CreateGroupCommandSCIM' - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMGroupDTO' - "400": - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMGroupDTO' - get: - tags: - - ScimGroups - summary: SCIM Get By Filter for Groups - operationId: ScimGroups_Get - parameters: - - name: excludedAttributes - in: query - schema: - type: string - - name: filter - in: query - schema: - type: string - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMGroupFilteredResponse' - /scim/groups/{groupId}: - get: - tags: - - ScimGroups - summary: SCIM Groups GET API. - operationId: ScimGroups_GetGroups - parameters: - - name: groupId - in: path - description: The data used to create a new user. - required: true - schema: - type: string - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMGroupDTO' - "400": - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMGroupDTO' - delete: - tags: - - ScimGroups - summary: Deletes a group. - operationId: ScimGroups_DeleteGroup - parameters: - - name: groupId - in: path - description: The data used to create a new group. - required: true - schema: - type: string - responses: - "200": - description: Success - patch: - tags: - - ScimGroups - summary: SCIM API for updating a group. - operationId: ScimGroups_UpdateGroup - parameters: - - name: groupId - in: path - description: The groupId of the group to be updated. - required: true - schema: - type: string - requestBody: - description: The data used to update a group. - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateUserCommandSCIM' - responses: - "200": - description: Success - /scim/users/{userId}: - get: - tags: - - ScimUsers - summary: SCIM API for getting a user. - operationId: ScimUsers_GetUsers - parameters: - - name: userId - in: path - description: userId of the user. - required: true - schema: - type: string - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMUserDTO' - "400": - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMUserDTO' - patch: - tags: - - ScimUsers - summary: SCIM API for updating a user. - operationId: ScimUsers_UpdateUsers - parameters: - - name: userId - in: path - description: The userId of the user to be updated. - required: true - schema: - type: string - requestBody: - description: The update payload used to perform the updates. - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateUserCommandSCIM' - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMUserDTO' - "400": - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMUserDTO' - delete: - tags: - - ScimUsers - summary: SCIM API for deleting a user. - operationId: ScimUsers_DeleteUsers - parameters: - - name: userId - in: path - description: userID of the user to be deleted. - required: true - schema: - type: string - responses: - "200": - description: Success - /scim/users: - get: - tags: - - ScimUsers - summary: SCIM API for getting a user given filters. - operationId: ScimUsers_Get - parameters: - - name: filter - in: query - description: filter for users. - schema: - type: string - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMUserFilteredResponse' - post: - tags: - - ScimUsers - summary: SCIM API for creating a new user. - operationId: ScimUsers_CreateUsers - requestBody: - description: The data used to create a new user. - content: - application/json: - schema: - $ref: '#/components/schemas/CreateUserCommandSCIM' - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMUserDTO' - "400": - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/SCIMUserDTO' /api/Setting: get: tags: @@ -858,9 +635,9 @@ paths: type: string - name: top in: query - description: The number of records to return. Default is 10. + description: The number of records to return. Default is 10. Range is 0 to 1000. schema: - maximum: 2147483647 + maximum: 1000 minimum: 0 type: integer format: int32 @@ -971,9 +748,9 @@ paths: type: string - name: top in: query - description: The number of records to return. Default is 10. + description: The number of records to return. Default is 10. Range is 0 to 1000. schema: - maximum: 2147483647 + maximum: 1000 minimum: 0 type: integer format: int32 @@ -1141,22 +918,6 @@ components: description: IDs of the users to be added as members of the group. nullable: true description: Command used to create a new local group. - CreateGroupCommandSCIM: - type: object - properties: - schemas: - type: array - items: - type: string - nullable: true - externalId: - type: string - nullable: true - displayName: - type: string - nullable: true - meta: - $ref: '#/components/schemas/MetaGroup' CreateOrUpdateSettingCommand: required: - key @@ -1302,34 +1063,6 @@ components: invitationAccepted: type: boolean description: Flag indicating whether the user has accepted invitation or not. - CreateUserCommandSCIM: - type: object - properties: - schemas: - type: array - items: - type: string - nullable: true - id: - type: string - nullable: true - externalId: - type: string - nullable: true - meta: - $ref: '#/components/schemas/Meta' - userName: - type: string - nullable: true - name: - $ref: '#/components/schemas/Name' - active: - type: boolean - emails: - type: array - items: - $ref: '#/components/schemas/Email' - nullable: true CreateUserLoginCommand: type: object properties: @@ -1437,17 +1170,6 @@ components: externalId: type: string nullable: true - Email: - type: object - properties: - value: - type: string - nullable: true - type: - type: string - nullable: true - primary: - type: boolean GroupDto: type: object properties: @@ -1542,36 +1264,6 @@ components: value: type: string nullable: true - Meta: - type: object - properties: - resourceType: - type: string - nullable: true - created: - type: string - nullable: true - lastModified: - type: string - nullable: true - MetaGroup: - type: object - properties: - resourceType: - type: string - nullable: true - Name: - type: object - properties: - formatted: - type: string - nullable: true - familyName: - type: string - nullable: true - givenName: - type: string - nullable: true RobotAccountDto: type: object properties: @@ -1617,113 +1309,6 @@ components: $ref: '#/components/schemas/RobotAccountDto' description: The results from the current page. nullable: true - SCIMGroupDTO: - type: object - properties: - schemas: - type: array - items: - type: string - nullable: true - id: - type: string - nullable: true - externalId: - type: string - nullable: true - meta: - $ref: '#/components/schemas/Meta' - displayName: - type: string - nullable: true - members: - type: array - items: - type: string - nullable: true - SCIMGroupFilteredResponse: - type: object - properties: - schemas: - type: array - items: - type: string - nullable: true - totalResults: - type: integer - format: int32 - resources: - type: array - items: - $ref: '#/components/schemas/SCIMGroupDTO' - nullable: true - startIndex: - type: integer - format: int32 - itemsPerPage: - type: integer - format: int32 - SCIMUserDTO: - type: object - properties: - schemas: - type: array - items: - type: string - nullable: true - id: - type: string - nullable: true - externalId: - type: string - nullable: true - meta: - $ref: '#/components/schemas/Meta' - userName: - type: string - nullable: true - name: - $ref: '#/components/schemas/Name' - active: - type: boolean - emails: - type: array - items: - $ref: '#/components/schemas/Email' - nullable: true - SCIMUserFilteredResponse: - type: object - properties: - schemas: - type: array - items: - type: string - nullable: true - totalResults: - type: integer - format: int32 - resources: - type: array - items: - $ref: '#/components/schemas/SCIMUserDTO' - nullable: true - startIndex: - type: integer - format: int32 - itemsPerPage: - type: integer - format: int32 - ScimOperation: - type: object - properties: - op: - type: string - nullable: true - path: - type: string - nullable: true - value: - nullable: true SettingDto: type: object properties: @@ -1889,19 +1474,6 @@ components: description: Extension user attributes this user should be removed from. nullable: true description: Command used to update the user. - UpdateUserCommandSCIM: - type: object - properties: - schemas: - type: array - items: - type: string - nullable: true - operations: - type: array - items: - $ref: '#/components/schemas/ScimOperation' - nullable: true UserDto: type: object properties: diff --git a/definitions/orchestrator.yaml b/definitions/orchestrator.yaml index 3f8e749..0064b38 100644 --- a/definitions/orchestrator.yaml +++ b/definitions/orchestrator.yaml @@ -1851,24 +1851,6 @@ paths: $ref: '#/components/schemas/ODataValueOfIEnumerableOfAlertDto' security: - OAuth2: [] - /odata/Alerts/UiPath.Server.Configuration.OData.ExpandCurrentUserGroupAlerts: - post: - tags: - - Alerts - description: |- - OAuth required scopes: OR.Monitoring or OR.Monitoring.Write. - - Required permissions: Alerts.View. - operationId: Alerts_ExpandCurrentUserGroupAlerts - responses: - "200": - description: Success - content: {} - "204": - description: No Content - content: {} - security: - - OAuth2: [] /odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount: get: tags: @@ -3066,90 +3048,6 @@ paths: $ref: '#/components/schemas/ODataValueOfIEnumerableOfAuditLogEntityDto' security: - OAuth2: [] - /odata/AuditLogs/UiPath.Server.Configuration.OData.Reports: - get: - tags: - - AuditLogs - summary: Returns a CSV containing the filtered audit. - description: "OAuth required scopes: OR.Audit or OR.Audit.Read.\n\nRequired permissions: Audit.View.\nDEPRECATED: \nPlease user other means to retrieve such reports: https://docs.uipath.com/orchestrator/automation-cloud/latest/release-notes/release-notes-june-2023#deprecation-of-reports-endpoints. This endpoint will be removed in future releases.\nPlease refer to https://docs.uipath.com/orchestrator/reference" - operationId: AuditLogs_Reports - parameters: - - name: x-UIPATH-AuditedService - in: header - schema: - type: string - default: Orchestrator - enum: - - Orchestrator - - TestAutomation - x-ms-enum: - name: AuditedService - modelAsString: false - x-ms-enum: - name: AuditedService - modelAsString: false - - name: x-UIPATH-AuditedService - in: query - schema: - type: string - default: Orchestrator - enum: - - Orchestrator - - TestAutomation - x-ms-enum: - name: AuditedService - modelAsString: false - x-ms-enum: - name: AuditedService - modelAsString: false - - 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/octet-stream: - schema: - type: string - format: binary - deprecated: true - security: - - OAuth2: [] /odata/Buckets: get: tags: @@ -8832,8 +8730,8 @@ paths: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -8990,8 +8888,8 @@ paths: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -11623,17 +11521,19 @@ paths: format: binary security: - OAuth2: [] - /odata/QueueDefinitions({key})/UiPathODataSvc.Reports: + /odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetFoldersForQueue(id={id}): get: tags: - QueueDefinitions - summary: Returns an Excel file containing all the items in the given queue. - description: "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.\nDEPRECATED: \nPlease user other means to retrieve such reports: https://docs.uipath.com/orchestrator/automation-cloud/latest/release-notes/release-notes-june-2023#deprecation-of-reports-endpoints. This endpoint will be removed in future releases.\nPlease refer to https://docs.uipath.com/orchestrator/reference" - operationId: QueueDefinitions_ReportsById + summary: Get all accesible folders where the queue is shared, and the total count of folders where it is shared (including unaccessible folders). + description: |- + OAuth required scopes: OR.Queues or OR.Queues.Read. + + Requires authentication. + operationId: QueueDefinitions_GetFoldersForQueueById parameters: - - name: key + - name: id in: path - description: Given queue's Id. required: true schema: type: integer @@ -11643,6 +11543,49 @@ paths: 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-name: folder-id + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccessibleFoldersDto' + security: + - OAuth2: [] + /odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetQueuesAcrossFolders: + get: + tags: + - QueueDefinitions + summary: Get the queues from all the folders in which the current user has the Queues.View permission, except the ones in the excluded folder. + description: |- + OAuth required scopes: OR.Queues or OR.Queues.Read. + + Requires authentication. + operationId: QueueDefinitions_GetQueuesAcrossFolders + parameters: + - name: excludeFolderId + in: query + 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: $filter in: query description: Restricts the set of items returned. The maximum number of expressions is 100. @@ -11687,40 +11630,22 @@ paths: "200": description: Success content: - application/octet-stream: + application/json: schema: - type: string - format: binary - deprecated: true + $ref: '#/components/schemas/ODataValueOfIEnumerableOfQueueDefinitionDto' security: - OAuth2: [] - /odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetFoldersForQueue(id={id}): - get: + /odata/QueueDefinitions/UiPath.Server.Configuration.OData.ShareToFolders: + post: tags: - QueueDefinitions - summary: Get all accesible folders where the queue is shared, and the total count of folders where it is shared (including unaccessible folders). + summary: Makes the queue visible in the specified folders. description: |- - OAuth required scopes: OR.Queues or OR.Queues.Read. + OAuth required scopes: OR.Queues or OR.Queues.Write. Requires authentication. - operationId: QueueDefinitions_GetFoldersForQueueById + operationId: QueueDefinitions_ShareToFolders 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 @@ -11729,170 +11654,72 @@ paths: format: int64 x-name: folder-id required: true + requestBody: + description: Object containing the ids of the queue definitions and the ids of the folders where they should be shared. + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/json-patch+json: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + application/*+json: + schema: + $ref: '#/components/schemas/QueueFoldersShareDto' + required: false responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/AccessibleFoldersDto' + "204": + description: No Content + content: {} + "404": + description: A queue or one of the folders specified does not exist. + content: {} security: - OAuth2: [] - /odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetQueuesAcrossFolders: + x-codegen-request-body-name: body + /odata/QueueItemComments: get: tags: - - QueueDefinitions - summary: Get the queues from all the folders in which the current user has the Queues.View permission, except the ones in the excluded folder. + - QueueItemComments + summary: Gets the QueueItemComments. description: |- OAuth required scopes: OR.Queues or OR.Queues.Read. - Requires authentication. - operationId: QueueDefinitions_GetQueuesAcrossFolders - parameters: - - name: excludeFolderId - in: query - 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: $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-name: folder-id - required: true - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ODataValueOfIEnumerableOfQueueDefinitionDto' - security: - - OAuth2: [] - /odata/QueueDefinitions/UiPath.Server.Configuration.OData.ShareToFolders: - post: - tags: - - QueueDefinitions - summary: Makes the queue visible in the specified folders. - description: |- - OAuth required scopes: OR.Queues or OR.Queues.Write. - - Requires authentication. - operationId: QueueDefinitions_ShareToFolders - parameters: - - name: X-UIPATH-OrganizationUnitId - in: header - description: Folder/OrganizationUnit Id - schema: - type: integer - format: int64 - x-name: folder-id - required: true - requestBody: - description: Object containing the ids of the queue definitions and the ids of the folders where they should be shared. - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/json-patch+json: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - application/*+json: - schema: - $ref: '#/components/schemas/QueueFoldersShareDto' - required: false - responses: - "204": - description: No Content - content: {} - "404": - description: A queue or one of the folders specified does not exist. - content: {} - security: - - OAuth2: [] - x-codegen-request-body-name: body - /odata/QueueItemComments: - get: - tags: - - QueueItemComments - summary: Gets the QueueItemComments. - description: |- - OAuth required scopes: OR.Queues or OR.Queues.Read. - - Required permissions: Queues.View and Transactions.View. - operationId: QueueItemComments_Get + Required permissions: Queues.View and Transactions.View. + operationId: QueueItemComments_Get parameters: - name: $expand in: query @@ -15115,74 +14942,6 @@ paths: $ref: '#/components/schemas/ODataValueOfInt64' security: - OAuth2: [] - /odata/RobotLogs/UiPath.Server.Configuration.OData.Reports: - get: - tags: - - RobotLogs - summary: Reports. - description: "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: Logs.View.\nDEPRECATED: \nPlease user other means to retrieve such reports: https://docs.uipath.com/orchestrator/automation-cloud/latest/release-notes/release-notes-june-2023#deprecation-of-reports-endpoints. This endpoint will be removed in future releases.\nPlease refer to https://docs.uipath.com/orchestrator/reference" - operationId: RobotLogs_Reports - parameters: - - name: fileNameSubject - in: query - 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-name: folder-id - required: true - responses: - "200": - description: Success - content: - application/octet-stream: - schema: - type: string - format: binary - deprecated: true - security: - - OAuth2: [] /odata/Robots: get: tags: @@ -16957,8 +16716,8 @@ paths: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -17054,8 +16813,8 @@ paths: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -19157,6 +18916,41 @@ paths: content: {} security: - OAuth2: [] + delete: + tags: + - TaskDefinitions + summary: Deletes Task Defintion/Version. + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Write. + + Required permissions: ActionDesign.Delete. + operationId: TaskDefinitions_DeleteById + parameters: + - name: key + in: path + description: Id of the task definition to be deleted + required: true + schema: + type: integer + format: int64 + - name: taskDefinitionVersion + in: query + description: Version of task definition to be deleted + schema: + type: integer + format: int64 + responses: + "204": + description: Deletion Successful. + content: {} + "409": + description: Task Defintion has associated Apps/Actions + content: {} + "404": + description: Not Found + content: {} + security: + - OAuth2: [] /odata/TaskDefinitions({key})/UiPath.Server.Configuration.OData.UpdateTaskDefinition: post: tags: @@ -24643,6 +24437,8 @@ components: assetName: minLength: 1 type: string + supportsCredentialsProxyDisconnected: + type: boolean AssetsSetRobotAssetsByKeyRequest: required: - robotAsset @@ -24684,8 +24480,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -24804,7 +24600,6 @@ components: - Folders - DirectoryService - Buckets - - DataRetentionPolicies - TenantMove - Secrets - PersonalWorkspaces @@ -25142,6 +24937,8 @@ components: format: uuid enableCoverage: type: boolean + maskBuildVersion: + type: boolean BulkAddQueueItemsRequest: required: - commitType @@ -25220,6 +25017,7 @@ components: - ExpectationFailed - MisdirectedRequest - UnprocessableEntity + - UnprocessableContent - Locked - FailedDependency - UpgradeRequired @@ -25546,6 +25344,15 @@ components: type: integer format: int64 description: Defines the resources such as assets, robots or bucket for a Credential Store. + CredentialsConnectionData: + type: object + properties: + url: + type: string + body: + type: string + bearerToken: + type: string CredentialsProxyResourceDto: required: - CredentialStoreId @@ -26160,8 +25967,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -26295,7 +26102,6 @@ components: - SharedAccessSignatureFailure - ProviderNotSupported - EmailAlreadyUsed - - MaxSiblingsLimitReached - InvalidAuditRelationship - InvalidOrganizationUnit - RequiredOrganizationUnit @@ -26618,6 +26424,9 @@ components: - AppTaskDataItemViolatesContentJsonSchema - TaskDefinitionSchemaNotAnObject - TaskDefinitionNameIsAlreadyUsed + - TaskDefintionVersionHaveActiveTasks + - TaskDefintionVersionHaveActiveApps + - FailedToRetrieveAssociatedApps - InvalidSecureStoreContext - MailSmtpSettingsError - CannotDeleteCalendarWhenUsedBySchedule @@ -26708,6 +26517,7 @@ components: - TestCaseDefinitionDuplicateIds - TestCaseDefinitionInUse - TestSetScheduleInvalidScheduleKey + - TestSetExecutionTriggerFailed - InvalidTenantMoveStatus - TenantMoveIdConflict - TenantMoveMigrationConflict @@ -26781,6 +26591,8 @@ components: - CredentialsProxyRequestFailedUnhandledError - CredentialsProxyRequestFailedBadRequest - CredentialsProxyTypeCannotBeCreated + - CredentialsProxyGetAssetFromDisconnectedProxyNotEnabled + - CredentialsProxyGetAssetFromDisconnectedProxyNotAllowedForThisActivityVersion - ServerlessCreateMachineTemplateErrorCode - ServerlessUpdateMachineTemplateErrorCode - ServerlessDeleteMachineTemplateErrorCode @@ -26809,6 +26621,8 @@ components: - SolutionPackageUrlIsInvalid - SolutionInstallationFolderNotFound - SolutionPackageNotInScope + - SolutionLibraryUrlIsInvalid + - TenantLibraryFeedNotEnabled - ExportTimeout - InvalidMessageReceived - IntegrationServiceApiFailure @@ -27440,8 +27254,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -28303,8 +28117,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -28343,8 +28157,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -28457,8 +28271,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -28510,6 +28324,44 @@ components: items: type: integer format: int64 + MachineCreatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + type: + type: string + enum: + - Standard + - Template + x-ms-enum: + name: MachineCreatedEventType + modelAsString: false + scope: + type: string + enum: + - Default + - Shared + - PersonalWorkspace + - Cloud + - Serverless + x-ms-enum: + name: MachineCreatedEventScope + modelAsString: false + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object MachineDeleteBulkRequest: type: object properties: @@ -28518,6 +28370,40 @@ components: items: type: integer format: int64 + MachineDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + type: + type: string + enum: + - Standard + - Template + x-ms-enum: + name: MachineDeletedEventType + modelAsString: false + scope: + type: string + enum: + - Default + - Shared + - PersonalWorkspace + - Cloud + - Serverless + x-ms-enum: + name: MachineDeletedEventScope + modelAsString: false + eventTime: + type: string + format: date-time + eventSource: + type: object MachineDto: required: - Name @@ -28709,8 +28595,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -28874,8 +28760,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -28948,6 +28834,44 @@ components: TriggersCount: type: integer format: int32 + MachineUpdatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + type: + type: string + enum: + - Standard + - Template + x-ms-enum: + name: MachineUpdatedEventType + modelAsString: false + scope: + type: string + enum: + - Default + - Shared + - PersonalWorkspace + - Cloud + - Serverless + x-ms-enum: + name: MachineUpdatedEventScope + modelAsString: false + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object MachineVpnSettingsDto: type: object properties: @@ -29645,6 +29569,46 @@ components: type: integer format: int64 description: "Stores information about an organization unit in Orchestrator.\r\n An orchestrator unit can be understood as a company department and it is used to group different entities." + PackageCreatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + feedId: + type: string + format: uuid + version: + type: string + type: + type: string + enum: + - Undefined + - Processes + - Libraries + - PersonalWorkspace + - FolderHierarchy + x-ms-enum: + name: PackageCreatedEventType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object PackageDeletedEvent: type: object properties: @@ -29663,6 +29627,46 @@ components: format: date-time eventSource: type: object + PackageUpdatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + version: + type: string + feedId: + type: string + format: uuid + type: + type: string + enum: + - Undefined + - Processes + - Libraries + - PersonalWorkspace + - FolderHierarchy + x-ms-enum: + name: PackageUpdatedEventType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object PackageUploadedEvent: type: object properties: @@ -29847,6 +29851,64 @@ components: Id: type: string format: uuid + ProcessCreatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + processVersion: + type: string + processType: + type: string + enum: + - Undefined + - Process + - TestAutomationProcess + x-ms-enum: + name: ProcessCreatedEventProcessType + modelAsString: false + entryPointId: + type: string + format: uuid + folderKeys: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object + ProcessDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object ProcessDto: type: object properties: @@ -29941,6 +30003,104 @@ components: Id: type: string description: A process is a project defined in UiPath Studio and published in Orchestrator from UiPath Studio or manually. + ProcessScheduleCreatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + runtimeType: + type: string + enum: + - NonProduction + - Attended + - Unattended + - Development + - Studio + - RpaDeveloper + - StudioX + - CitizenDeveloper + - Headless + - StudioPro + - RpaDeveloperPro + - TestAutomation + - AutomationCloud + - Serverless + - AutomationKit + - ServerlessTestAutomation + - AutomationCloudTestAutomation + - AttendedStudioWeb + x-ms-enum: + name: ProcessScheduleCreatedEventRuntimeType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + dependencies: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object + ProcessScheduleDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + runtimeType: + type: string + enum: + - NonProduction + - Attended + - Unattended + - Development + - Studio + - RpaDeveloper + - StudioX + - CitizenDeveloper + - Headless + - StudioPro + - RpaDeveloperPro + - TestAutomation + - AutomationCloud + - Serverless + - AutomationKit + - ServerlessTestAutomation + - AutomationCloudTestAutomation + - AttendedStudioWeb + x-ms-enum: + name: ProcessScheduleDeletedEventRuntimeType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + dependencies: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object ProcessScheduleDto: required: - Name @@ -30007,8 +30167,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -30204,6 +30364,57 @@ components: type: integer format: int64 x-webhook-event: schedule.failed + ProcessScheduleUpdatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + runtimeType: + type: string + enum: + - NonProduction + - Attended + - Unattended + - Development + - Studio + - RpaDeveloper + - StudioX + - CitizenDeveloper + - Headless + - StudioPro + - RpaDeveloperPro + - TestAutomation + - AutomationCloud + - Serverless + - AutomationKit + - ServerlessTestAutomation + - AutomationCloudTestAutomation + - AttendedStudioWeb + x-ms-enum: + name: ProcessScheduleUpdatedEventRuntimeType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + dependencies: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object ProcessSetEnabledRequest: type: object properties: @@ -30234,6 +30445,44 @@ components: type: boolean AlwaysRunning: type: boolean + ProcessUpdatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + processVersion: + type: string + processType: + type: string + enum: + - Undefined + - Process + - TestAutomationProcess + x-ms-enum: + name: ProcessUpdatedEventProcessType + modelAsString: false + entryPointId: + type: string + format: uuid + folderKeys: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object ProcessesSetArgumentsRequest: required: - arguments @@ -31656,8 +31905,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -32202,6 +32451,8 @@ components: 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 @@ -32362,8 +32613,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -32605,8 +32856,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -32776,8 +33027,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -33332,8 +33583,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -33639,8 +33890,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -33755,8 +34006,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -33802,12 +34053,12 @@ components: type: object properties: Name: - maxLength: 64 + maxLength: 1024 minLength: 0 type: string description: The name of the person for which the user is created. Surname: - maxLength: 64 + maxLength: 1024 minLength: 0 type: string description: The surname of the person for which the user is created. @@ -33919,8 +34170,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -34158,8 +34409,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -34618,6 +34869,40 @@ components: description: List of tags associated to the task. items: $ref: '#/components/schemas/TagDto' + TaskCreatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + type: + type: string + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: TaskCreatedEventType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object TaskCreatedEventDto: required: - EventId @@ -34921,6 +35206,36 @@ components: type: array items: $ref: '#/components/schemas/TaskDefintionAssociatedVersionsDto' + TaskDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + type: + type: string + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: TaskDeletedEventType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object TaskDeletedEventDto: required: - EventId @@ -35436,6 +35751,40 @@ components: description: Tags collection items: $ref: '#/components/schemas/TagDto' + TaskUpdatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + type: + type: string + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: TaskUpdatedEventType + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object TasksAssignRequest: required: - taskAssignments @@ -35776,8 +36125,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -36204,8 +36553,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -36590,12 +36939,12 @@ components: type: object properties: Name: - maxLength: 64 + maxLength: 1024 minLength: 0 type: string description: The name of the person for which the user is created. Surname: - maxLength: 64 + maxLength: 1024 minLength: 0 type: string description: The surname of the person for which the user is created. @@ -36707,8 +37056,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -36816,24 +37165,44 @@ components: properties: Queues: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Robots: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Jobs: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Schedules: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Tasks: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true QueueItems: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Insights: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true CloudRobots: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Serverless: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true Export: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true UserOrganizationUnitDto: type: object properties: @@ -37050,6 +37419,40 @@ components: MaxDurationSeconds: type: integer format: int32 + WebhookCreatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + url: + type: string + eventTime: + type: string + format: date-time + eventSource: + type: object + WebhookDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + url: + type: string + eventTime: + type: string + format: date-time + eventSource: + type: object WebhookDto: required: - AllowInsecureSsl @@ -37358,6 +37761,23 @@ components: format: int64 readOnly: true description: This class defines DTO for Tasks Collection for webhook event Task.Created + WebhookUpdatedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + description: + type: string + url: + type: string + eventTime: + type: string + format: date-time + eventSource: + type: object WrappedEnvironmentDto: type: object properties: @@ -37503,8 +37923,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless @@ -37730,8 +38150,8 @@ components: - StudioX - CitizenDeveloper - Headless - - RpaDeveloperPro - StudioPro + - RpaDeveloperPro - TestAutomation - AutomationCloud - Serverless