diff --git a/definitions/du.framework.yaml b/definitions/du.framework.yaml index 7bd5051..172f4f1 100644 --- a/definitions/du.framework.yaml +++ b/definitions/du.framework.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: - title: Document Understanding REST APIs Preview - description: Document Understanding as a Service, exposing framework capabilities as REST APIs. All the APIs are in the context of a Document Understanding project. Both pre-trained and custom resources are available for consumption.

Additional details can be found here. + title: Document Understanding Cloud APIs + description: Consume Document Understanding capabilities via APIs, hosted in the cloud. All the APIs are in the context of a Document Understanding project. Both pre-trained and custom resources are available for consumption.

Additional details can be found here. version: "1.0" paths: /projects: @@ -785,6 +785,9 @@ paths: schema: type: string default: 00000000-0000-0000-0000-000000000000 + - name: x-uipath-page-range + in: header + description: Specifies the page range of the document to be digitized. Page range can be provided as a range of consecutive pages (e.g. 2-5), as one specific page (e.g. 2) or as a range of consecutive pages and individual pages (e.g. 2-5,6,7). It also allows the specification of the start (^) and the end ($) of the document (e.g. ^-3,5-$). requestBody: content: multipart/form-data: @@ -894,6 +897,118 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + /projects/{projectId}/digitization/result/{documentId}: + get: + tags: + - Digitization + summary: "" + description: "Get the digitization result of a document.\r\n
Required scopes: Du.Digitization.Api
" + operationId: Get + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: ID of the Project. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: documentId + in: path + description: The document identifier obtained from the START digitization route. + required: true + responses: + "200": + description: Success + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse' + "400": + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' /projects/{projectId}/classifiers/{classifierId}/classification: post: tags: @@ -2559,6 +2674,19 @@ components: - Expression - TableExpression type: string + UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.ActionStatus: + enum: + - Unassigned + - Pending + - Completed + type: string + UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.CreateTaskPriority: + enum: + - Low + - Medium + - High + - Critical + type: string UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody: type: object properties: @@ -2610,6 +2738,42 @@ components: result: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.Classification.ClassificationResponse' additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse: + type: object + properties: + status: + title: Operation Status + enum: + - Succeeded + - Failed + - Running + - NotStarted + type: enum + example: Succeeded + error: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + result: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResult' + createdAt: + type: string + description: The time the operation was created + format: date-time + example: "2022-06-21T13:49:00.4971596Z" + lastUpdatedAt: + type: string + description: The last time the operation was updated + format: date-time + example: "2022-06-21T13:49:10.1105179Z" + additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResult: + type: object + properties: + documentObjectModel: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.SerializedResult' + documentText: + type: string + nullable: true + additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.StartDigitizationResponse: type: object properties: @@ -2949,11 +3113,18 @@ components: result: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.SerializedResult: + type: object + properties: + result: + type: string + nullable: true + additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.ClassificationValidationResult: type: object properties: actionStatus: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Core.Model.ValidationTaskStatus' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.ActionStatus' actionData: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Services.Model.DocumentClassificationActionDataModel' validatedClassificationResults: @@ -2967,7 +3138,7 @@ components: type: object properties: actionStatus: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Core.Model.ValidationTaskStatus' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.ActionStatus' actionData: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Services.Model.DocumentExtractionActionDataModel' validatedExtractionResults: @@ -3034,6 +3205,7 @@ components: type: string description: The Document ID associated with the Extraction Result that needs validation format: uuid + nullable: true example: ID of the Document that needs to be validated actionTitle: type: string @@ -3041,7 +3213,7 @@ components: nullable: true example: Title of the action in action center actionPriority: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Core.Model.CreateTaskActionPriority' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.CreateTaskPriority' actionCatalog: type: string description: The name of the catalog in which the action is created. @@ -3076,6 +3248,7 @@ components: type: string description: The Document ID associated with the Extraction Result that needs validation format: uuid + nullable: true example: ID of the Document that needs to be validated actionTitle: type: string @@ -3083,7 +3256,7 @@ components: nullable: true example: Title of the action in action center actionPriority: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Validation.Core.Model.CreateTaskActionPriority' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Common.OrchestratorClient.Model.CreateTaskPriority' actionCatalog: type: string description: The name of the catalog in which the action is created. @@ -3160,19 +3333,6 @@ components: $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Results.ClassificationResult' nullable: true additionalProperties: false - UiPath.DocumentUnderstanding.Framework.Validation.Core.Model.CreateTaskActionPriority: - enum: - - Low - - Medium - - High - - Critical - type: string - UiPath.DocumentUnderstanding.Framework.Validation.Core.Model.ValidationTaskStatus: - enum: - - Unassigned - - Pending - - Completed - type: string UiPath.DocumentUnderstanding.Framework.Validation.Services.Model.DocumentClassificationActionDataModel: type: object properties: @@ -3296,7 +3456,7 @@ components: securitySchemes: oauth2: type: oauth2 - description: In order to enable access to the REST API 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. + 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 diff --git a/definitions/identity.yaml b/definitions/identity.yaml index 8da070b..79929b8 100644 --- a/definitions/identity.yaml +++ b/definitions/identity.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: IdentityServer External API - version: v1 + version: 23.9.6-release.20 servers: - url: https://cloud.uipath.com/identity_ paths: @@ -21,7 +21,6 @@ paths: in: query schema: type: string - nullable: true - name: top in: query schema: @@ -40,7 +39,6 @@ paths: in: query schema: type: string - nullable: true - name: sortOrder in: query schema: @@ -49,15 +47,9 @@ paths: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/AuditQueryRecordDtoPagedResult' application/json: schema: $ref: '#/components/schemas/AuditQueryRecordDtoPagedResult' - text/json: - schema: - $ref: '#/components/schemas/AuditQueryRecordDtoPagedResult' /api/AuditQuery/{organizationId}/download: get: tags: @@ -74,20 +66,19 @@ paths: in: query schema: type: string - nullable: true - name: size in: query schema: type: integer format: int32 - nullable: true responses: "200": description: Success content: application/octet-stream: schema: - type: string + type: file + format: binary /api/Group/{partitionGlobalId}: get: tags: @@ -102,27 +93,16 @@ paths: required: true schema: type: string - description: partition id format: uuid responses: "200": description: Success content: - text/plain: - schema: - type: array - items: - $ref: '#/components/schemas/GroupDto' application/json: schema: type: array items: $ref: '#/components/schemas/GroupDto' - text/json: - schema: - type: array - items: - $ref: '#/components/schemas/GroupDto' delete: tags: - Group @@ -138,21 +118,12 @@ paths: format: uuid requestBody: content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/BulkGroupDeleteCommand' application/json: schema: $ref: '#/components/schemas/BulkGroupDeleteCommand' - text/json: - schema: - $ref: '#/components/schemas/BulkGroupDeleteCommand' - application/*+json: - schema: - $ref: '#/components/schemas/BulkGroupDeleteCommand' responses: "204": - description: Success + description: No Content /api/Group/{partitionGlobalId}/{groupId}: get: tags: @@ -177,15 +148,9 @@ paths: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/GroupDto' application/json: schema: $ref: '#/components/schemas/GroupDto' - text/json: - schema: - $ref: '#/components/schemas/GroupDto' delete: tags: - Group @@ -207,7 +172,7 @@ paths: format: uuid responses: "204": - description: Success + description: No Content /api/Group: post: tags: @@ -217,31 +182,16 @@ paths: operationId: Group_CreateGroup requestBody: content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/CreateGroupCommand' application/json: schema: $ref: '#/components/schemas/CreateGroupCommand' - text/json: - schema: - $ref: '#/components/schemas/CreateGroupCommand' - application/*+json: - schema: - $ref: '#/components/schemas/CreateGroupCommand' responses: "201": - description: Success + description: Created content: - text/plain: - schema: - $ref: '#/components/schemas/GroupDto' application/json: schema: $ref: '#/components/schemas/GroupDto' - text/json: - schema: - $ref: '#/components/schemas/GroupDto' /api/Group/{groupId}: put: tags: @@ -258,31 +208,16 @@ paths: format: uuid requestBody: content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/UpdateGroupCommand' application/json: schema: $ref: '#/components/schemas/UpdateGroupCommand' - text/json: - schema: - $ref: '#/components/schemas/UpdateGroupCommand' - application/*+json: - schema: - $ref: '#/components/schemas/UpdateGroupCommand' responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/GroupDto' application/json: schema: $ref: '#/components/schemas/GroupDto' - text/json: - schema: - $ref: '#/components/schemas/GroupDto' /api/MessageTemplate/{templateId}: get: tags: @@ -300,15 +235,9 @@ paths: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/MessageTemplateDto' application/json: schema: $ref: '#/components/schemas/MessageTemplateDto' - text/json: - schema: - $ref: '#/components/schemas/MessageTemplateDto' put: tags: - MessageTemplate @@ -323,31 +252,16 @@ paths: format: int64 requestBody: content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/UpdateMessageTemplateCommand' application/json: schema: $ref: '#/components/schemas/UpdateMessageTemplateCommand' - text/json: - schema: - $ref: '#/components/schemas/UpdateMessageTemplateCommand' - application/*+json: - schema: - $ref: '#/components/schemas/UpdateMessageTemplateCommand' responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/MessageTemplateDto' application/json: schema: $ref: '#/components/schemas/MessageTemplateDto' - text/json: - schema: - $ref: '#/components/schemas/MessageTemplateDto' /api/MessageTemplate: get: tags: @@ -359,20 +273,13 @@ paths: in: query schema: type: string - nullable: true responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/MessageTemplateDto' application/json: schema: $ref: '#/components/schemas/MessageTemplateDto' - text/json: - schema: - $ref: '#/components/schemas/MessageTemplateDto' /api/RobotAccount/{partitionGlobalId}: get: tags: @@ -391,7 +298,6 @@ paths: in: query schema: type: string - nullable: true - name: top in: query description: The number of records to return. Default is 10. @@ -399,7 +305,6 @@ paths: maximum: 2147483647 minimum: 0 type: integer - description: The number of records to return. Default is 10. format: int32 - name: skip in: query @@ -408,15 +313,12 @@ paths: maximum: 2147483647 minimum: 0 type: integer - description: The number of records to skip. Default is 0. format: int32 - name: sortBy in: query description: The name of the field to sort by. schema: type: string - description: The name of the field to sort by. - nullable: true - name: sortOrder in: query description: The sort order. @@ -426,15 +328,9 @@ paths: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/RobotAccountDtoPagedResultDto' application/json: schema: $ref: '#/components/schemas/RobotAccountDtoPagedResultDto' - text/json: - schema: - $ref: '#/components/schemas/RobotAccountDtoPagedResultDto' delete: tags: - RobotAccount @@ -450,21 +346,12 @@ paths: format: uuid requestBody: content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/BulkRobotAccountDeleteCommand' application/json: schema: $ref: '#/components/schemas/BulkRobotAccountDeleteCommand' - text/json: - schema: - $ref: '#/components/schemas/BulkRobotAccountDeleteCommand' - application/*+json: - schema: - $ref: '#/components/schemas/BulkRobotAccountDeleteCommand' responses: "204": - description: Success + description: No Content /api/RobotAccount/{partitionGlobalId}/{robotAccountId}: get: tags: @@ -489,15 +376,9 @@ paths: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/RobotAccountDto' application/json: schema: $ref: '#/components/schemas/RobotAccountDto' - text/json: - schema: - $ref: '#/components/schemas/RobotAccountDto' delete: tags: - RobotAccount @@ -519,7 +400,7 @@ paths: format: uuid responses: "204": - description: Success + description: No Content /api/RobotAccount: post: tags: @@ -529,31 +410,16 @@ paths: operationId: RobotAccount_CreateRobotAccount requestBody: content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/CreateRobotAccountCommand' application/json: schema: $ref: '#/components/schemas/CreateRobotAccountCommand' - text/json: - schema: - $ref: '#/components/schemas/CreateRobotAccountCommand' - application/*+json: - schema: - $ref: '#/components/schemas/CreateRobotAccountCommand' responses: "201": - description: Success + description: Created content: - text/plain: - schema: - $ref: '#/components/schemas/RobotAccountDto' application/json: schema: $ref: '#/components/schemas/RobotAccountDto' - text/json: - schema: - $ref: '#/components/schemas/RobotAccountDto' /api/RobotAccount/{robotAccountId}: put: tags: @@ -570,267 +436,393 @@ paths: format: uuid requestBody: content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/UpdateRobotAccountCommand' application/json: schema: $ref: '#/components/schemas/UpdateRobotAccountCommand' - text/json: - schema: - $ref: '#/components/schemas/UpdateRobotAccountCommand' - application/*+json: - schema: - $ref: '#/components/schemas/UpdateRobotAccountCommand' responses: "200": description: Success content: - text/plain: + 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/RobotAccountDto' - text/json: + $ref: '#/components/schemas/SCIMGroupDTO' + "400": + description: Bad Request + content: + application/json: schema: - $ref: '#/components/schemas/RobotAccountDto' - /api/Setting: + $ref: '#/components/schemas/SCIMGroupDTO' get: tags: - - Setting - summary: Get an application settings for a list of keys in a tenant - description: 'OAuth required scopes: PM.Setting or PM.Setting.Read.' - operationId: Setting_GetSettingsBulk + - ScimGroups + summary: SCIM Get By Filter for Groups + operationId: ScimGroups_Get parameters: - - name: key - in: query - style: form - schema: - type: array - items: - type: string - nullable: true - explode: true - - name: partitionGlobalId + - name: excludedAttributes in: query schema: type: string - format: uuid - nullable: true - - name: userId + - name: filter in: query schema: type: string - format: uuid - nullable: true responses: "200": description: Success content: - text/plain: + application/json: schema: - type: array - items: - $ref: '#/components/schemas/SettingDto' + $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: - type: array - items: - $ref: '#/components/schemas/SettingDto' - text/json: + $ref: '#/components/schemas/SCIMGroupDTO' + "400": + description: Bad Request + content: + application/json: schema: - type: array - items: - $ref: '#/components/schemas/SettingDto' - put: + $ref: '#/components/schemas/SCIMGroupDTO' + /scim/groups/{groupId}: + delete: tags: - - Setting - summary: Updates or create new settings if they don't exist on a specific tenant. - description: 'OAuth required scopes: PM.Setting or PM.Setting.Write.' - operationId: Setting_UpdateSettings + - 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: A bulk command to create/update a list of settings on a specific tenant. + description: The data used to update a group. content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/BulkCreateOrUpdateSettingsCommand' application/json: schema: - $ref: '#/components/schemas/BulkCreateOrUpdateSettingsCommand' - text/json: - schema: - $ref: '#/components/schemas/BulkCreateOrUpdateSettingsCommand' - application/*+json: - schema: - $ref: '#/components/schemas/BulkCreateOrUpdateSettingsCommand' + $ref: '#/components/schemas/UpdateUserCommandSCIM' responses: "200": description: Success - content: - text/plain: - schema: - type: array - items: - $ref: '#/components/schemas/SettingDto' - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/SettingDto' - text/json: - schema: - type: array - items: - $ref: '#/components/schemas/SettingDto' - "409": - description: Conflict - /api/User/{userId}: + /scim/users/{userId}: get: tags: - - User - summary: Get the user at the specified location - description: 'OAuth required scopes: PM.User or PM.User.Read.' - operationId: User_GetUser + - ScimUsers + summary: SCIM API for getting a user. + operationId: ScimUsers_GetUsers parameters: - name: userId in: path - description: The data used to create a new user. + description: userId of the user. required: true schema: type: string - description: The data used to create a new user. - format: uuid responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/UserDto' application/json: schema: - $ref: '#/components/schemas/UserDto' - text/json: + $ref: '#/components/schemas/SCIMUserDTO' + "400": + description: Bad Request + content: + application/json: schema: - $ref: '#/components/schemas/UserDto' - put: + $ref: '#/components/schemas/SCIMUserDTO' + patch: tags: - - User - summary: Updates the specified user. - description: Updating user groups requires partition administrator group membership. - operationId: User_Update + - ScimUsers + summary: SCIM API for updating a user. + operationId: ScimUsers_UpdateUsers parameters: - name: userId in: path - description: The database identifier of the user. + description: The userId of the user to be updated. required: true schema: type: string - description: The database identifier of the user. - format: uuid requestBody: - description: The command that stores the information to update user. + description: The update payload used to perform the updates. content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/UpdateUserCommand' application/json: schema: - $ref: '#/components/schemas/UpdateUserCommand' - text/json: - schema: - $ref: '#/components/schemas/UpdateUserCommand' - application/*+json: - schema: - $ref: '#/components/schemas/UpdateUserCommand' + $ref: '#/components/schemas/UpdateUserCommandSCIM' responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/IdentityResult' application/json: schema: - $ref: '#/components/schemas/IdentityResult' - text/json: - schema: - $ref: '#/components/schemas/IdentityResult' + $ref: '#/components/schemas/SCIMUserDTO' "400": description: Bad Request content: - text/plain: - schema: - $ref: '#/components/schemas/IdentityResult' application/json: schema: - $ref: '#/components/schemas/IdentityResult' - text/json: - schema: - $ref: '#/components/schemas/IdentityResult' + $ref: '#/components/schemas/SCIMUserDTO' delete: tags: - - User - summary: Deletes the specified user. - operationId: User_Delete + - ScimUsers + summary: SCIM API for deleting a user. + operationId: ScimUsers_DeleteUsers parameters: - name: userId in: path - description: The id of the user that will be deleted. + description: userID of the user to be deleted. required: true schema: type: string - description: The id of the user that will be deleted. - format: uuid responses: - "204": + "200": description: Success - /api/User: - post: + /scim/users: + get: tags: - - User - summary: Creates a new user. This API is idempotent, the existing user will be deleted if trying to be created again. - description: Creating user in a group requires partition administrator group membership. - operationId: User_CreateUser + - 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-patch+json: - schema: - $ref: '#/components/schemas/CreateUserCommand' application/json: schema: - $ref: '#/components/schemas/CreateUserCommand' - text/json: - schema: - $ref: '#/components/schemas/CreateUserCommand' - application/*+json: + $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: + - Setting + summary: Get an application settings for a list of keys in a tenant + description: 'OAuth required scopes: PM.Setting or PM.Setting.Read.' + operationId: Setting_GetSettingsBulk + parameters: + - name: key + in: query + style: form + schema: + type: array + items: + type: string + explode: true + - name: partitionGlobalId + in: query + schema: + type: string + format: uuid + - name: userId + in: query + schema: + type: string + format: uuid + responses: + "200": + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SettingDto' + put: + tags: + - Setting + summary: Updates or create new settings if they don't exist on a specific tenant. + description: 'OAuth required scopes: PM.Setting or PM.Setting.Write.' + operationId: Setting_UpdateSettings + requestBody: + description: A bulk command to create/update a list of settings on a specific tenant. + content: + application/json: schema: - $ref: '#/components/schemas/CreateUserCommand' + $ref: '#/components/schemas/BulkCreateOrUpdateSettingsCommand' responses: "200": description: Success content: - text/plain: + application/json: schema: - $ref: '#/components/schemas/IdentityResult' + type: array + items: + $ref: '#/components/schemas/SettingDto' + "409": + description: Conflict + /api/User/{userId}: + get: + tags: + - User + summary: Get the user at the specified location + description: 'OAuth required scopes: PM.User or PM.User.Read.' + operationId: User_GetUser + parameters: + - name: userId + in: path + description: The data used to create a new user. + required: true + schema: + type: string + format: uuid + responses: + "200": + description: Success + content: application/json: schema: - $ref: '#/components/schemas/IdentityResult' - text/json: + $ref: '#/components/schemas/UserDto' + put: + tags: + - User + summary: Updates the specified user. + description: Updating user groups requires partition administrator group membership. + operationId: User_Update + parameters: + - name: userId + in: path + description: The database identifier of the user. + required: true + schema: + type: string + format: uuid + requestBody: + description: The command that stores the information to update user. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUserCommand' + responses: + "200": + description: Success + content: + application/json: schema: $ref: '#/components/schemas/IdentityResult' "400": description: Bad Request content: - text/plain: + application/json: schema: $ref: '#/components/schemas/IdentityResult' + delete: + tags: + - User + summary: Deletes the specified user. + operationId: User_Delete + parameters: + - name: userId + in: path + description: The id of the user that will be deleted. + required: true + schema: + type: string + format: uuid + responses: + "204": + description: No Content + /api/User: + post: + tags: + - User + summary: Creates a new user. This API is idempotent, the existing user will be deleted if trying to be created again. + description: Creating user in a group requires partition administrator group membership. + operationId: User_CreateUser + requestBody: + description: The data used to create a new user. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUserCommand' + responses: + "200": + description: Success + content: application/json: schema: $ref: '#/components/schemas/IdentityResult' - text/json: + "400": + description: Bad Request + content: + application/json: schema: $ref: '#/components/schemas/IdentityResult' delete: @@ -841,21 +833,62 @@ paths: requestBody: description: The bulk delete command. content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/BulkSoftDeleteCommand' application/json: schema: $ref: '#/components/schemas/BulkSoftDeleteCommand' - text/json: - schema: - $ref: '#/components/schemas/BulkSoftDeleteCommand' - application/*+json: - schema: - $ref: '#/components/schemas/BulkSoftDeleteCommand' responses: "204": + description: No Content + /api/User/users/{partitionGlobalId}: + get: + tags: + - User + description: 'OAuth required scopes: PM.User or PM.User.Read.' + operationId: User_GetUsers + parameters: + - name: partitionGlobalId + in: path + required: true + schema: + type: string + format: uuid + - name: searchTerm + in: query + schema: + type: string + - name: top + in: query + description: The number of records to return. Default is 10. + schema: + maximum: 2147483647 + minimum: 0 + type: integer + format: int32 + - name: skip + in: query + description: The number of records to skip. Default is 0. + schema: + maximum: 2147483647 + minimum: 0 + type: integer + format: int32 + - name: sortBy + in: query + description: The name of the field to sort by. + schema: + type: string + - name: sortOrder + in: query + description: The sort order. + schema: + $ref: '#/components/schemas/SortOrderDto' + responses: + "200": description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDtoPagedResultDto' /api/User/BulkCreate: post: tags: @@ -866,43 +899,22 @@ paths: requestBody: description: The data used to create a users in bulk. content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/CreateUsersCommand' application/json: schema: $ref: '#/components/schemas/CreateUsersCommand' - text/json: - schema: - $ref: '#/components/schemas/CreateUsersCommand' - application/*+json: - schema: - $ref: '#/components/schemas/CreateUsersCommand' responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/IdentityResult' application/json: schema: $ref: '#/components/schemas/IdentityResult' - text/json: - schema: - $ref: '#/components/schemas/IdentityResult' "400": description: Bad Request content: - text/plain: - schema: - $ref: '#/components/schemas/IdentityResult' application/json: schema: $ref: '#/components/schemas/IdentityResult' - text/json: - schema: - $ref: '#/components/schemas/IdentityResult' /api/User/{userId}/changepassword: post: tags: @@ -917,48 +929,26 @@ paths: required: true schema: type: string - description: The database user id. format: uuid requestBody: description: The change user password command.. content: - application/json-patch+json: - schema: - $ref: '#/components/schemas/ChangeUserPasswordCommand' application/json: schema: $ref: '#/components/schemas/ChangeUserPasswordCommand' - text/json: - schema: - $ref: '#/components/schemas/ChangeUserPasswordCommand' - application/*+json: - schema: - $ref: '#/components/schemas/ChangeUserPasswordCommand' responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/IdentityResult' application/json: schema: $ref: '#/components/schemas/IdentityResult' - text/json: - schema: - $ref: '#/components/schemas/IdentityResult' "400": description: Bad Request content: - text/plain: - schema: - $ref: '#/components/schemas/IdentityResult' application/json: schema: $ref: '#/components/schemas/IdentityResult' - text/json: - schema: - $ref: '#/components/schemas/IdentityResult' /api/User/{userId}/loginAttempts: get: tags: @@ -973,15 +963,12 @@ paths: required: true schema: type: string - description: The data used to create a new user. format: uuid - name: userSID in: query description: The AD user SID. schema: type: string - description: The AD user SID. - nullable: true - name: top in: query description: The number of records to return. Default is 10. @@ -989,7 +976,6 @@ paths: maximum: 2147483647 minimum: 0 type: integer - description: The number of records to return. Default is 10. format: int32 - name: skip in: query @@ -998,15 +984,12 @@ paths: maximum: 2147483647 minimum: 0 type: integer - description: The number of records to skip. Default is 0. format: int32 - name: sortBy in: query description: The name of the field to sort by. schema: type: string - description: The name of the field to sort by. - nullable: true - name: sortOrder in: query description: The sort order. @@ -1017,32 +1000,16 @@ paths: description: The date since records should be returned. schema: type: string - description: The date since records should be returned. format: date-time - nullable: true responses: "200": description: Success content: - text/plain: - schema: - $ref: '#/components/schemas/UserLoginAttemptDtoPagedResultDto' application/json: schema: $ref: '#/components/schemas/UserLoginAttemptDtoPagedResultDto' - text/json: - schema: - $ref: '#/components/schemas/UserLoginAttemptDtoPagedResultDto' components: schemas: - SortOrder: - enum: - - asc - - desc - type: string - x-ms-enum: - name: SortOrder - modelAsString: false AuditQueryRecordDto: type: object properties: @@ -1084,114 +1051,27 @@ components: items: $ref: '#/components/schemas/AuditQueryRecordDto' nullable: true - GroupType: - enum: - - builtIn - - custom - type: string - x-ms-enum: - name: GroupType - modelAsString: false - DirectoryEntity: + BulkCreateOrUpdateSettingsCommand: required: - - objectType - type: object - properties: - objectType: - type: string - source: - type: string - nullable: true - identifier: - type: string - nullable: true - name: - type: string - nullable: true - email: - type: string - nullable: true - displayName: - type: string - nullable: true - discriminator: - propertyName: objectType - DirectoryUser: - allOf: - - $ref: '#/components/schemas/DirectoryEntity' - - type: object - properties: - firstName: - type: string - nullable: true - lastName: - type: string - nullable: true - jobTitle: - type: string - nullable: true - companyName: - type: string - nullable: true - city: - type: string - nullable: true - department: - type: string - nullable: true - DirectoryGroup: - allOf: - - $ref: '#/components/schemas/DirectoryEntity' - - type: object - DirectoryRobotUser: - allOf: - - $ref: '#/components/schemas/DirectoryEntity' - - type: object - DirectoryApplication: - allOf: - - $ref: '#/components/schemas/DirectoryEntity' - - type: object - properties: - applicationId: - type: string - nullable: true - GroupDto: + - settings type: object properties: - id: + settings: + type: array + items: + $ref: '#/components/schemas/CreateOrUpdateSettingCommand' + description: The list of settings to be created/updated. + partitionGlobalId: type: string - description: The database id (Guid). + description: The partition global Id of the setting format: uuid - name: - type: string - description: The unique name of the group. - nullable: true - displayName: - type: string - description: The friendly name of the group. nullable: true - deprecated: true - type: - $ref: '#/components/schemas/GroupType' - creationTime: - type: string - description: The group's creation time. - format: date-time - lastModificationTime: + userId: type: string - description: The group's last modification time. - format: date-time - nullable: true - members: - type: array - items: - oneOf: - - $ref: '#/components/schemas/DirectoryUser' - - $ref: '#/components/schemas/DirectoryGroup' - - $ref: '#/components/schemas/DirectoryRobotUser' - - $ref: '#/components/schemas/DirectoryApplication' + description: The user global Id of the setting. + format: uuid nullable: true - description: Represents a group entity. + description: Class used to create/update a list of settings in a bulk operation. BulkGroupDeleteCommand: type: object properties: @@ -1203,141 +1083,93 @@ components: description: IDs of the groups to be removed nullable: true description: Command used to delete multiple groups. - CreateGroupCommand: + BulkRobotAccountDeleteCommand: type: object properties: - partitionGlobalId: - type: string - description: Group partition identifier - format: uuid - id: - type: string - description: Group unique identifier - format: uuid - name: - type: string - description: Group Name - nullable: true - directoryUserMemberIDs: + robotAccountIDs: type: array items: type: string format: uuid - description: IDs of the users to be added as members of the group. + description: IDs of the robot accounts to be removed nullable: true - description: Command used to create a new local group. - UpdateGroupCommand: + description: Command used for deleting multiple robot accounts. + BulkSoftDeleteCommand: type: object properties: partitionGlobalId: type: string - description: Group partition identifier format: uuid - name: - type: string - description: Group Name - nullable: true - directoryUserIDsToAdd: - type: array - items: - type: string - format: uuid - description: IDs of the users to be added as members of the group. - nullable: true - directoryUserIDsToRemove: + userIds: type: array items: type: string format: uuid - description: IDs of the users to be removed from the group. nullable: true - description: Command used to update group information. - MessageTemplateDto: + ChangeUserPasswordCommand: type: object properties: - id: - type: integer - format: int64 - name: + oldPassword: type: string + description: The user's old password. nullable: true - value: + newPassword: type: string + description: The user's new password. nullable: true - UpdateMessageTemplateCommand: + description: Command used to change user's password. + CreateGroupCommand: type: object properties: - id: - type: integer - format: int64 - value: + partitionGlobalId: type: string - nullable: true - description: Command used to update an existing message template - SortOrderDto: - enum: - - asc - - desc - type: string - x-ms-enum: - name: SortOrderDto - modelAsString: false - RobotAccountDto: - type: object - properties: + description: Group partition identifier + format: uuid id: type: string - description: The database id (Guid). + description: Group unique identifier format: uuid name: type: string - description: The unique name of the robot account. - nullable: true - displayName: - type: string - description: The friendly name of the robot account. - nullable: true - creationTime: - type: string - description: The RobotAccount's creation time. - format: date-time - lastLoginTime: - type: string - description: The robot account's last login time. - format: date-time + description: Group Name nullable: true - groupIds: + directoryUserMemberIDs: type: array items: type: string format: uuid - description: Groups that this robot account is member of + description: IDs of the users to be added as members of the group. nullable: true - description: Represents a user to run unattended process - RobotAccountDtoPagedResultDto: + description: Command used to create a new local group. + CreateGroupCommandSCIM: type: object properties: - totalCount: - type: integer - description: The total number of entities. - format: int64 - results: + schemas: type: array items: - $ref: '#/components/schemas/RobotAccountDto' - description: The results from the current page. + type: string nullable: true - BulkRobotAccountDeleteCommand: + externalId: + type: string + nullable: true + displayName: + type: string + nullable: true + meta: + $ref: '#/components/schemas/MetaGroup' + CreateOrUpdateSettingCommand: + required: + - key type: object properties: - robotAccountIDs: - type: array - items: - type: string - format: uuid - description: IDs of the robot accounts to be removed + key: + type: string + description: The setting Key + value: + type: string + description: The value of the setting. nullable: true - description: Command used for deleting multiple robot accounts. + description: Command used to create or update an application setting. CreateRobotAccountCommand: type: object properties: @@ -1361,167 +1193,639 @@ components: description: IDs of the groups this robot account should be added to. nullable: true description: Command used to create a new robot account. - UpdateRobotAccountCommand: + CreateUserCommand: type: object properties: - partitionGlobalId: + id: type: string - description: Robot account partition identifier + description: The user global id format: uuid - displayName: + nullable: true + userName: type: string - description: The friendly name of the robot account. + description: The user's name. nullable: true - groupIDsToAdd: - type: array - items: - type: string - format: uuid - description: IDs of the groups this robot account should be added to. + email: + type: string + description: The user's email address. + format: email nullable: true - groupIDsToRemove: - type: array - items: - type: string - format: uuid - description: IDs of the groups this robot account should be removed from. + name: + type: string + description: The name of the user. nullable: true - description: "Command used to update robot account information.\r\nOnly Display Name and group membership can be change. \r\nUsername is read-only after creation since change in username cannot be handled in Orchestrator" - SettingDto: - type: object - properties: - id: + surname: + type: string + description: The name of the user. + nullable: true + displayName: + type: string + description: Display name of the user + nullable: true + type: + $ref: '#/components/schemas/UserType' + bypassBasicAuthRestriction: + type: boolean + description: Flag indicating if this user will bypass the basic authentication restriction. + legacyId: + type: integer + description: "User legacy id can be specified from an external source. If null, uses the default auto-increment behavior.\r\nThis is needed to stay in sync with the TMS user data while we are in dual-mode." + format: int64 + nullable: true + invitationAccepted: + type: boolean + description: Flag indicating whether the user has accepted invitation or not. + partitionGlobalId: + type: string + description: The tenant global id that the user belongs to. + format: uuid + password: + type: string + description: The user's password. + nullable: true + validatePassword: + type: boolean + description: Flag indicating if we need to validate the password. + groupIDs: + type: array + items: + type: string + format: uuid + description: IDs of the groups this user is a member of. + nullable: true + userLogins: + type: array + items: + $ref: '#/components/schemas/CreateUserLoginCommand' + description: The user logins + nullable: true + description: Command used to create a new user. + CreateUserCommandBase: + type: object + properties: + id: + type: string + description: The user global id + format: uuid + nullable: true + userName: + type: string + description: The user's name. + nullable: true + email: + type: string + description: The user's email address. + format: email + nullable: true + name: + type: string + description: The name of the user. + nullable: true + surname: + type: string + description: The name of the user. + nullable: true + displayName: + type: string + description: Display name of the user + nullable: true + type: + $ref: '#/components/schemas/UserType' + bypassBasicAuthRestriction: + type: boolean + description: Flag indicating if this user will bypass the basic authentication restriction. + legacyId: + type: integer + description: "User legacy id can be specified from an external source. If null, uses the default auto-increment behavior.\r\nThis is needed to stay in sync with the TMS user data while we are in dual-mode." + format: int64 + nullable: true + 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: + loginProvider: + type: string + description: Gets or sets the login provider for the login (e.g. facebook, google) + nullable: true + providerKey: + type: string + description: Gets or sets the unique provider identifier for this login. + nullable: true + providerDisplayName: + type: string + description: Gets or sets the friendly name used in a UI for this login. + nullable: true + CreateUsersCommand: + type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/CreateUserCommandBase' + description: Users information. + nullable: true + partitionGlobalId: + type: string + description: The tenant global id that the user belongs to. + format: uuid + groupIDs: + type: array + items: + type: string + format: uuid + description: IDs of the groups this user is a member of. + nullable: true + description: Command used to create new users. + DirectoryApplication: + type: object + allOf: + - $ref: '#/components/schemas/DirectoryEntity' + properties: + applicationId: + type: string + nullable: true + DirectoryEntity: + required: + - objectType + type: object + properties: + objectType: + type: string + identifier: + type: string + nullable: true + name: + type: string + nullable: true + displayName: + type: string + nullable: true + source: + type: string + nullable: true + email: + type: string + nullable: true + discriminator: + propertyName: objectType + DirectoryGroup: + type: object + allOf: + - $ref: '#/components/schemas/DirectoryEntity' + DirectoryRobotUser: + type: object + allOf: + - $ref: '#/components/schemas/DirectoryEntity' + DirectoryUser: + type: object + allOf: + - $ref: '#/components/schemas/DirectoryEntity' + properties: + firstName: + type: string + nullable: true + lastName: + type: string + nullable: true + jobTitle: + type: string + nullable: true + companyName: + type: string + nullable: true + city: + type: string + nullable: true + department: + type: string + nullable: true + extensionUserAttributes: + type: object + additionalProperties: + type: string + nullable: true + 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: + id: + type: string + description: The database id (Guid). + format: uuid + name: + type: string + description: The unique name of the group. + nullable: true + displayName: + type: string + description: The friendly name of the group. + nullable: true + deprecated: true + type: + $ref: '#/components/schemas/GroupType' + creationTime: + type: string + description: The group's creation time. + format: date-time + lastModificationTime: + type: string + description: The group's last modification time. + format: date-time + nullable: true + members: + type: array + items: + oneOf: + - $ref: '#/components/schemas/DirectoryUser' + - $ref: '#/components/schemas/DirectoryGroup' + - $ref: '#/components/schemas/DirectoryRobotUser' + - $ref: '#/components/schemas/DirectoryApplication' + nullable: true + description: Represents a group entity. + GroupType: + enum: + - builtIn + - custom + type: string + x-ms-enum: + name: GroupType + modelAsString: false + IdentityError: + type: object + properties: + code: + type: string + nullable: true + description: + type: string + nullable: true + IdentityResult: + type: object + properties: + succeeded: + type: boolean + readOnly: true + errors: + type: array + items: + $ref: '#/components/schemas/IdentityError' + nullable: true + readOnly: true + LoginAttemptResult: + enum: + - success + - invalidPassword + - userIsNotActive + - invalidUserNameTenancyName + - tenantIsNotActive + - userEmailIsNotConfirmed + - unknownExternalLogin + - lockedOut + - externalFailedAuthentication + - adLogin + type: string + x-ms-enum: + name: LoginAttemptResult + modelAsString: false + MessageTemplateDto: + type: object + properties: + id: type: integer - description: The database id. format: int64 - key: + name: type: string - description: The setting Key nullable: true value: type: string - description: The value of the setting. nullable: true - partitionGlobalId: + Meta: + type: object + properties: + resourceType: type: string - description: Value indicating if the partition this setting belongs to. - format: uuid - userId: + nullable: true + created: type: string - description: The user global Id of the setting. + 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: + id: + type: string + description: The database id (Guid). format: uuid + name: + type: string + description: The unique name of the robot account. nullable: true - CreateOrUpdateSettingCommand: - required: - - key + displayName: + type: string + description: The friendly name of the robot account. + nullable: true + creationTime: + type: string + description: The RobotAccount's creation time. + format: date-time + lastLoginTime: + type: string + description: The robot account's last login time. + format: date-time + nullable: true + groupIds: + type: array + items: + type: string + format: uuid + description: Groups that this robot account is member of + nullable: true + description: Represents a user to run unattended process + RobotAccountDtoPagedResultDto: type: object properties: - key: + totalCount: + type: integer + description: The total number of entities. + format: int64 + results: + type: array + items: + $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 - description: The setting Key - value: + nullable: true + externalId: type: string - description: The value of the setting. nullable: true - description: Command used to create or update an application setting. - BulkCreateOrUpdateSettingsCommand: - required: - - settings + meta: + $ref: '#/components/schemas/Meta' + displayName: + type: string + nullable: true + members: + type: array + items: + type: string + nullable: true + SCIMGroupFilteredResponse: type: object properties: - settings: + schemas: type: array items: - $ref: '#/components/schemas/CreateOrUpdateSettingCommand' - description: The list of settings to be created/updated. + 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: + id: + type: integer + description: The database id. + format: int64 + key: + type: string + description: The setting Key + nullable: true + value: + type: string + description: The value of the setting. + nullable: true partitionGlobalId: type: string - description: The partition global Id of the setting + description: Value indicating if the partition this setting belongs to. format: uuid - nullable: true userId: type: string description: The user global Id of the setting. format: uuid nullable: true - description: Class used to create/update a list of settings in a bulk operation. - UserType: + SortOrder: enum: - - user - - robot - - directoryUser - - directoryGroup - - robotAccount - - application + - asc + - desc type: string - description: Defines how a user was created and how it is supposed to be used. x-ms-enum: - name: UserType + name: SortOrder modelAsString: false - UserDto: + SortOrderDto: + enum: + - asc + - desc + type: string + x-ms-enum: + name: SortOrderDto + modelAsString: false + UpdateGroupCommand: type: object properties: - id: + partitionGlobalId: type: string - description: The database id (Guid). + description: Group partition identifier format: uuid - userName: - type: string - description: The username. - nullable: true - email: - type: string - description: The user's email address. - nullable: true - emailConfirmed: - type: boolean - description: Whether the user`s email has been confirmed or not. name: type: string - description: The first name of the user. + description: Group Name nullable: true - surname: - type: string - description: The last name of the user. + directoryUserIDsToAdd: + type: array + items: + type: string + format: uuid + description: IDs of the users to be added as members of the group. nullable: true - displayName: + directoryUserIDsToRemove: + type: array + items: + type: string + format: uuid + description: IDs of the users to be removed from the group. + nullable: true + description: Command used to update group information. + UpdateMessageTemplateCommand: + type: object + properties: + id: + type: integer + format: int64 + value: type: string - description: Display name of the user. nullable: true - creationTime: + description: Command used to update an existing message template + UpdateRobotAccountCommand: + type: object + properties: + partitionGlobalId: type: string - description: The user's creation time. - format: date-time - lastModificationTime: + description: Robot account partition identifier + format: uuid + displayName: type: string - description: The user's last modification time. - format: date-time + description: The friendly name of the robot account. nullable: true - lastLoginTime: - type: string - description: The user's last login time. - format: date-time + groupIDsToAdd: + type: array + items: + type: string + format: uuid + description: IDs of the groups this robot account should be added to. nullable: true - groupIDs: + groupIDsToRemove: type: array items: type: string format: uuid + description: IDs of the groups this robot account should be removed from. nullable: true - legacyId: - type: integer - format: int64 - isActive: - type: boolean - description: Flag indicating if the user is active. - bypassBasicAuthRestriction: - type: boolean - description: Flag indicating if this user will bypass the basic authentication restriction. - type: - $ref: '#/components/schemas/UserType' - invitationAccepted: - type: boolean - description: Flag indicating whether the user has accepted invitation or not. + description: "Command used to update robot account information.\r\nOnly Display Name and group membership can be change. \r\nUsername is read-only after creation since change in username cannot be handled in Orchestrator" UpdateUserCommand: type: object properties: @@ -1572,213 +1876,109 @@ components: type: boolean description: Flag indicating whether the user has accepted invitation or not. nullable: true - description: Command used to update the user. - IdentityError: - type: object - properties: - code: - type: string - nullable: true - description: - type: string + extensionUserAttributesToAddOrUpdate: + type: object + additionalProperties: + type: string + description: Extension user attributes this user should be added to or updated on. nullable: true - IdentityResult: - type: object - properties: - succeeded: - type: boolean - readOnly: true - errors: + extensionUserAttributesToRemove: type: array items: - $ref: '#/components/schemas/IdentityError' - nullable: true - readOnly: true - CreateUserLoginCommand: - type: object - properties: - loginProvider: - type: string - description: Gets or sets the login provider for the login (e.g. facebook, google) - nullable: true - providerKey: - type: string - description: Gets or sets the unique provider identifier for this login. - nullable: true - providerDisplayName: - type: string - description: Gets or sets the friendly name used in a UI for this login. + type: string + description: Extension user attributes this user should be removed from. nullable: true - CreateUserCommand: + description: Command used to update the user. + UpdateUserCommandSCIM: type: object properties: - partitionGlobalId: - type: string - description: The tenant global id that the user belongs to. - format: uuid - password: - type: string - description: The user's password. - nullable: true - validatePassword: - type: boolean - description: Flag indicating if we need to validate the password. - groupIDs: + schemas: type: array items: type: string - format: uuid - description: IDs of the groups this user is a member of. nullable: true - userLogins: + operations: type: array items: - $ref: '#/components/schemas/CreateUserLoginCommand' - description: The user logins + $ref: '#/components/schemas/ScimOperation' nullable: true + UserDto: + type: object + properties: id: type: string - description: The user global id + description: The database id (Guid). format: uuid - nullable: true userName: type: string - description: The user's name. + description: The username. nullable: true email: type: string description: The user's email address. - format: email nullable: true + emailConfirmed: + type: boolean + description: Whether the user`s email has been confirmed or not. name: type: string - description: The name of the user. + description: The first name of the user. nullable: true surname: type: string - description: The name of the user. + description: The last name of the user. nullable: true displayName: type: string - description: Display name of the user + description: Display name of the user. nullable: true - type: - $ref: '#/components/schemas/UserType' - bypassBasicAuthRestriction: - type: boolean - description: Flag indicating if this user will bypass the basic authentication restriction. - legacyId: - type: integer - description: "User legacy id can be specified from an external source. If null, uses the default auto-increment behavior.\r\nThis is needed to stay in sync with the TMS user data while we are in dual-mode." - format: int64 + creationTime: + type: string + description: The user's creation time. + format: date-time + lastModificationTime: + type: string + description: The user's last modification time. + format: date-time nullable: true - invitationAccepted: - type: boolean - description: Flag indicating whether the user has accepted invitation or not. - description: Command used to create a new user. - BulkSoftDeleteCommand: - type: object - properties: - partitionGlobalId: + lastLoginTime: type: string - format: uuid - userIds: + description: The user's last login time. + format: date-time + nullable: true + groupIDs: type: array items: type: string format: uuid nullable: true - CreateUserCommandBase: - type: object - properties: - id: - type: string - description: The user global id - format: uuid - nullable: true - userName: - type: string - description: The user's name. - nullable: true - email: - type: string - description: The user's email address. - format: email - nullable: true - name: - type: string - description: The name of the user. - nullable: true - surname: - type: string - description: The name of the user. - nullable: true - displayName: - type: string - description: Display name of the user - nullable: true - type: - $ref: '#/components/schemas/UserType' - bypassBasicAuthRestriction: - type: boolean - description: Flag indicating if this user will bypass the basic authentication restriction. legacyId: type: integer - description: "User legacy id can be specified from an external source. If null, uses the default auto-increment behavior.\r\nThis is needed to stay in sync with the TMS user data while we are in dual-mode." format: int64 - nullable: true + isActive: + type: boolean + description: Flag indicating if the user is active. + bypassBasicAuthRestriction: + type: boolean + description: Flag indicating if this user will bypass the basic authentication restriction. + type: + $ref: '#/components/schemas/UserType' invitationAccepted: type: boolean description: Flag indicating whether the user has accepted invitation or not. - CreateUsersCommand: + UserDtoPagedResultDto: type: object properties: - users: - type: array - items: - $ref: '#/components/schemas/CreateUserCommandBase' - description: Users information. - nullable: true - partitionGlobalId: - type: string - description: The tenant global id that the user belongs to. - format: uuid - groupIDs: + totalCount: + type: integer + description: The total number of entities. + format: int64 + results: type: array items: - type: string - format: uuid - description: IDs of the groups this user is a member of. - nullable: true - description: Command used to create new users. - ChangeUserPasswordCommand: - type: object - properties: - oldPassword: - type: string - description: The user's old password. - nullable: true - newPassword: - type: string - description: The user's new password. + $ref: '#/components/schemas/UserDto' + description: The results from the current page. nullable: true - description: Command used to change user's password. - LoginAttemptResult: - enum: - - success - - invalidPassword - - userIsNotActive - - invalidUserNameTenancyName - - tenantIsNotActive - - userEmailIsNotConfirmed - - unknownExternalLogin - - lockedOut - - externalFailedAuthentication - - adLogin - type: string - x-ms-enum: - name: LoginAttemptResult - modelAsString: false UserLoginAttemptDto: type: object properties: @@ -1834,6 +2034,19 @@ components: $ref: '#/components/schemas/UserLoginAttemptDto' description: The results from the current page. nullable: true + UserType: + enum: + - user + - robot + - directoryUser + - directoryGroup + - robotAccount + - application + type: string + description: Defines how a user was created and how it is supposed to be used. + x-ms-enum: + name: UserType + modelAsString: false securitySchemes: Bearer: type: apiKey diff --git a/definitions/orchestrator.yaml b/definitions/orchestrator.yaml index b229abb..e8e9b31 100644 --- a/definitions/orchestrator.yaml +++ b/definitions/orchestrator.yaml @@ -75,7 +75,7 @@ paths: description: |- OAuth required scopes: OR.Users or OR.Users.Read. - Required permissions: Users.View or Units.Edit or SubFolders.Edit. + Required permissions: (Users.View or Units.Edit or SubFolders.Edit). operationId: DirectoryService_GetDomains responses: "200": @@ -96,7 +96,7 @@ paths: description: |- OAuth required scopes: OR.Users or OR.Users.Read. - Required permissions: Users.View or Units.Edit or SubFolders.Edit. + Required permissions: (Users.View or Units.Edit or SubFolders.Edit). operationId: DirectoryService_SearchForUsersAndGroups parameters: - name: searchContext @@ -436,7 +436,7 @@ paths: format: int32 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -511,7 +511,7 @@ paths: format: int32 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -1517,7 +1517,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -1550,7 +1550,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -1665,7 +1665,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Bad Request @@ -1704,7 +1704,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Bad Request @@ -1786,7 +1786,7 @@ paths: description: Success content: {} "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -2769,7 +2769,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "404": description: Asset or one of the folders specified does not exist. @@ -2992,10 +2992,7 @@ paths: tags: - AuditLogs summary: Returns a CSV containing the filtered audit. - description: |- - OAuth required scopes: OR.Audit or OR.Audit.Read. - - Required permissions: Audit.View. + 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 @@ -3071,6 +3068,7 @@ paths: schema: type: string format: binary + deprecated: true security: - OAuth2: [] /odata/Buckets: @@ -3397,7 +3395,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -3921,7 +3919,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "404": description: One of the specified entities does not exist. @@ -4042,7 +4040,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -4175,7 +4173,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -4368,7 +4366,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -4502,7 +4500,7 @@ paths: type: boolean responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -4965,7 +4963,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -5119,7 +5117,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -5197,7 +5195,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -5276,7 +5274,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -5355,7 +5353,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -5666,7 +5664,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -5706,6 +5704,70 @@ paths: format: binary security: - OAuth2: [] + /odata/Exports({key}): + get: + tags: + - Exports + description: Requires authentication. + operationId: Exports_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/ExportModel' + security: + - OAuth2: [] + /odata/Exports({key})/UiPath.Server.Configuration.OData.GetDownloadLink: + get: + tags: + - Exports + description: Requires authentication. + operationId: Exports_GetDownloadLinkById + 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/BlobFileAccessDto' + security: + - OAuth2: [] /odata/Folders: get: tags: @@ -5819,7 +5881,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -5853,7 +5915,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -6051,7 +6113,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -6121,7 +6183,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -6183,7 +6245,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -6245,7 +6307,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -6307,7 +6369,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -6821,7 +6883,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -6940,7 +7002,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} "404": description: Not Found @@ -8071,7 +8133,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -9016,7 +9078,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -9149,7 +9211,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -9278,7 +9340,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Empty machineIds collection in payload @@ -9405,139 +9467,6 @@ paths: $ref: '#/components/schemas/ODataValueOfIEnumerableOfMachineRuntimeDto' security: - OAuth2: [] - /odata/MessageTemplates: - get: - tags: - - MessageTemplates - summary: Gets the message templates. - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Read. - - Host only. Requires authentication. - operationId: MessageTemplates_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/ODataValueOfIEnumerableOfMessageTemplateDto' - security: - - OAuth2: [] - /odata/MessageTemplates('{key}'): - put: - tags: - - MessageTemplates - summary: Edits a message template. - description: |- - OAuth required scopes: OR.Administration or OR.Administration.Write. - - Host only. Requires authentication. - operationId: MessageTemplates_PutById - parameters: - - name: key - in: path - description: Message template name - required: true - schema: - type: string - requestBody: - description: Message template entity - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/json-patch+json: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - application/*+json: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - required: false - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/MessageTemplateDto' - "400": - description: No message template was found with the given name. - content: {} - security: - - OAuth2: [] - x-codegen-request-body-name: body /odata/OrganizationUnits: get: tags: @@ -9652,7 +9581,7 @@ paths: schema: $ref: '#/components/schemas/OrganizationUnitDto' "201": - description: Success + description: Created content: application/json: schema: @@ -9779,7 +9708,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} deprecated: true security: @@ -10142,7 +10071,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -10166,7 +10095,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -10189,7 +10118,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -10742,7 +10671,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -10867,18 +10796,9 @@ paths: $ref: '#/components/schemas/ProcessScheduleDto' required: false responses: - "200": - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ProcessScheduleDto' "204": - description: Successful put - content: - application/json: - schema: - $ref: '#/components/schemas/ProcessScheduleDto' + description: No Content + content: {} security: - OAuth2: [] x-codegen-request-body-name: body @@ -10908,7 +10828,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -11346,7 +11266,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -11621,10 +11541,7 @@ paths: 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. - - Required permissions: Queues.View and Transactions.View. + 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 parameters: - name: key @@ -11687,6 +11604,7 @@ paths: schema: type: string format: binary + deprecated: true security: - OAuth2: [] /odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetFoldersForQueue(id={id}): @@ -11870,7 +11788,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "404": description: A queue or one of the folders specified does not exist. @@ -12010,7 +11928,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -12164,7 +12082,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -12658,7 +12576,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -13629,7 +13547,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -13789,7 +13707,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -13963,7 +13881,7 @@ paths: schema: $ref: '#/components/schemas/QueueItemDto' "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -14175,7 +14093,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -14327,7 +14245,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -14487,7 +14405,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -15041,10 +14959,7 @@ paths: tags: - RobotLogs summary: Reports. - description: |- - OAuth required scopes: OR.Monitoring or OR.Monitoring.Read. - - Required permissions: Logs.View. + 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 @@ -15104,6 +15019,7 @@ paths: schema: type: string format: binary + deprecated: true security: - OAuth2: [] /odata/Robots: @@ -15236,7 +15152,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -15390,7 +15306,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -15613,7 +15529,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Empty robotIds collection in payload @@ -16278,7 +16194,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -16408,7 +16324,7 @@ paths: format: int32 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -16728,7 +16644,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Bad Request @@ -16793,7 +16709,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -17158,6 +17074,68 @@ paths: $ref: '#/components/schemas/ODataValueOfIEnumerableOfString' security: - OAuth2: [] + /odata/Sessions/UiPath.Server.Configuration.OData.SetMaintenanceMode: + post: + tags: + - Sessions + summary: Sets the execution capabilities for a specified host + description: |- + OAuth required scopes: OR.Robots or OR.Robots.Write. + + Required permissions: Robots.Edit. + operationId: Sessions_SetMaintenanceMode + requestBody: + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/json-patch+json: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + application/*+json: + schema: + $ref: '#/components/schemas/SessionMaintenanceModeParameters' + required: false + responses: + "204": + description: No Content + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body /odata/Settings: get: tags: @@ -17492,7 +17470,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -18911,7 +18889,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "404": description: One of the specified entities does not exist. @@ -18919,6 +18897,254 @@ paths: security: - OAuth2: [] x-codegen-request-body-name: body + /odata/TaskDefinitions: + get: + tags: + - TaskDefinitions + summary: Gets Task Definition objects with the given OData queries. + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Read. + + Required permissions: ActionDesign.View. + operationId: TaskDefinitions_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/ODataValueOfIEnumerableOfTaskDefinitionDto' + security: + - OAuth2: [] + /odata/TaskDefinitions({key}): + get: + tags: + - TaskDefinitions + summary: Gets a Task Definition item by Id. + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Read. + + Required permissions: ActionDesign.View. + operationId: TaskDefinitions_GetById + parameters: + - name: key + in: path + description: id of the object + 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/TaskDefinitionDto' + "404": + description: Not Found + content: {} + security: + - OAuth2: [] + /odata/TaskDefinitions({key})/UiPath.Server.Configuration.OData.UpdateTaskDefinition: + post: + tags: + - TaskDefinitions + summary: Updates Task Definition. + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Write. + + Required permissions: ActionDesign.Edit. + operationId: TaskDefinitions_UpdateTaskDefinitionById + parameters: + - name: key + in: path + description: Key of the object + required: true + schema: + type: integer + format: int64 + requestBody: + description: TaskDefinition to be updated + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + required: false + responses: + "200": + description: Updated + content: {} + "404": + description: Not Found + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body + /odata/TaskDefinitions/UiPath.Server.Configuration.OData.CreateTaskDefinition: + post: + tags: + - TaskDefinitions + summary: Creates a new Task Definition. + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Write. + + Required permissions: ActionDesign.Create. + operationId: TaskDefinitions_CreateTaskDefinition + 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: + description: The Task Definition to be created. + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TaskDefinitionRequest' + required: false + responses: + "201": + description: Created response. + content: + application/json: + schema: + $ref: '#/components/schemas/TaskDefinitionDto' + security: + - OAuth2: [] + x-codegen-request-body-name: body /odata/TaskNotes/UiPath.Server.Configuration.OData.CreateTaskNote: post: tags: @@ -18996,7 +19222,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -20063,7 +20289,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -20125,7 +20351,7 @@ paths: format: int32 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -20794,7 +21020,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -21210,7 +21436,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -21489,7 +21715,7 @@ paths: required: true responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -21752,7 +21978,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -21882,7 +22108,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -22421,7 +22647,7 @@ paths: schema: $ref: '#/components/schemas/UserDto' "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -22594,7 +22820,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -22727,7 +22953,7 @@ paths: format: int64 responses: "204": - description: Success + description: No Content content: {} security: - OAuth2: [] @@ -22831,7 +23057,7 @@ paths: type: string responses: "202": - description: Success + description: Accepted content: application/json: schema: @@ -22980,7 +23206,7 @@ paths: required: false responses: "202": - description: Success + description: Accepted content: application/json: schema: @@ -22988,6 +23214,199 @@ paths: security: - OAuth2: [] x-codegen-request-body-name: body + /tasks/AppTasks/CompleteAppTask: + post: + tags: + - AppTasks + summary: Complete the task by saving app task data and action taken + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Write. + + Required permissions: Tasks.Edit. + operationId: AppTasks_CompleteAppTask + parameters: + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-name: folder-id + required: true + requestBody: + description: TaskCompletionRequest + content: + application/json: + schema: + $ref: '#/components/schemas/TaskCompletionRequest' + required: false + responses: + "204": + description: No Content + content: {} + "400": + description: Bad Request + content: {} + "404": + description: Not Found + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body + /tasks/AppTasks/CreateAppTask: + post: + tags: + - AppTasks + summary: Creates a new App Task. + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Write. + + Required permissions: Tasks.Create. + operationId: AppTasks_CreateAppTask + parameters: + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-name: folder-id + required: true + requestBody: + description: The app task to be created. + content: + application/json: + schema: + $ref: '#/components/schemas/AppTasksCreateRequest' + required: false + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/AppTasksDataDto' + "400": + description: Bad Request + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body + /tasks/AppTasks/GetAppTaskById: + get: + tags: + - AppTasks + summary: Returns dto to render app task + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Read. + + Required permissions: Tasks.View. + operationId: AppTasks_GetAppTaskById + parameters: + - name: taskId + in: query + description: Task id + schema: + type: integer + format: int64 + - 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/AppTasksDataDto' + "404": + description: Not Found + content: {} + security: + - OAuth2: [] + /tasks/AppTasks/SaveAndReassignAppTasks: + post: + tags: + - AppTasks + summary: Save changes done by the current user and Reassign Task to another user + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Write. + + Required permissions: Tasks.Edit. + operationId: AppTasks_SaveAndReassignAppTasks + parameters: + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-name: folder-id + required: true + requestBody: + description: TaskSaveAndReassignmentRequest + content: + application/json: + schema: + $ref: '#/components/schemas/TaskSaveAndReassignmentRequest' + required: false + responses: + "204": + description: No Content + content: {} + "400": + description: Bad Request + content: {} + "404": + description: Not Found + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body + /tasks/AppTasks/SaveAppTasksData: + put: + tags: + - AppTasks + summary: Save task data + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Write. + + Required permissions: Tasks.Edit. + operationId: AppTasks_SaveAppTasksData + parameters: + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-name: folder-id + required: true + requestBody: + description: TaskDataSaveRequest + content: + application/json: + schema: + $ref: '#/components/schemas/TaskDataSaveRequest' + required: false + responses: + "204": + description: No Content + content: {} + "400": + description: Bad Request + content: {} + "404": + description: Not Found + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body /tasks/GenericTasks/CompleteTask: post: tags: @@ -23016,7 +23435,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Bad Request @@ -23055,7 +23474,7 @@ paths: required: false responses: "201": - description: Success + description: Created content: application/json: schema: @@ -23128,7 +23547,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Bad Request @@ -23167,7 +23586,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Bad Request @@ -23206,7 +23625,7 @@ paths: required: false responses: "204": - description: Success + description: No Content content: {} "400": description: Bad Request @@ -23340,6 +23759,221 @@ components: items: type: string format: uuid + AppTasksCreateRequest: + required: + - appId + - appVersion + - taskDefinitionId + - title + type: object + properties: + taskDefinitionId: + type: integer + description: Id for associated task definition + format: int64 + taskDefinitionVersion: + type: integer + description: Version of Task Definition to get associated properties + format: int32 + appId: + maxLength: 34 + minLength: 1 + type: string + description: Id representing AppId for AppTask + appVersion: + type: integer + description: Version of App for AppTask + format: int32 + type: + type: string + description: Gets or sets type of this task, allowed type is 'ExternalTask'. + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: TaskCreateRequestType + modelAsString: false + title: + maxLength: 512 + minLength: 0 + type: string + description: Gets or sets title of this task. + priority: + type: string + description: Gets or sets priority of this task. + enum: + - Low + - Medium + - High + - Critical + x-ms-enum: + name: BaseTaskCreateRequestPriority + modelAsString: false + data: + type: object + description: Task data + taskCatalogName: + maxLength: 50 + type: string + description: Gets or sets the task catalog/category of the task + externalTag: + maxLength: 128 + type: string + description: Reference or name of external system + tags: + type: array + description: List of tags associated to the task. + items: + $ref: '#/components/schemas/TagDto' + description: Class with only attributes needed for Creating Task (TaskType = TaskType.AppTask) + AppTasksDataDto: + type: object + properties: + appTasksMetadata: + $ref: '#/components/schemas/AppTasksMetadataDto' + status: + type: string + description: Task status + enum: + - Unassigned + - Pending + - Completed + x-ms-enum: + name: TaskDataDtoStatus + modelAsString: false + data: + type: object + description: Task form data json + action: + type: string + description: Task form action + waitJobState: + type: string + description: State of the job(if any) waiting on the current task + enum: + - Pending + - Running + - Stopping + - Terminating + - Faulted + - Successful + - Stopped + - Suspended + - Resumed + x-ms-enum: + name: TaskDataDtoWaitJobState + modelAsString: false + organizationUnitFullyQualifiedName: + type: string + description: Fully qualified folder name + tags: + type: array + description: List of tags associated to the task. + items: + $ref: '#/components/schemas/TagDto' + assignedToUser: + $ref: '#/components/schemas/UserLoginInfoDto' + title: + type: string + description: Gets or sets title of this task. + type: + type: string + description: Gets or sets type of this task. + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: TaskMetadataDtoType + modelAsString: false + priority: + type: string + description: Gets or sets priority of this task. + enum: + - Low + - Medium + - High + - Critical + x-ms-enum: + name: TaskMetadataDtoPriority + modelAsString: false + assignedToUserId: + type: integer + description: Gets the id of the actual assigned user, if any. + format: int64 + organizationUnitId: + type: integer + description: Gets or sets the folder/organization-unit id. + format: int64 + externalTag: + type: string + description: Identifier of external system where this task is handled + creatorJobKey: + type: string + description: Key of the job which created this task + format: uuid + waitJobKey: + type: string + description: Key job which is waiting on this task + format: uuid + lastAssignedTime: + type: string + description: Datetime when task was last assigned. + format: date-time + completionTime: + type: string + description: Datetime when task was completed. + format: date-time + isDeleted: + type: boolean + deleterUserId: + type: integer + format: int64 + deletionTime: + type: string + format: date-time + 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 + description: Dto with attributes required for App Task + AppTasksMetadataDto: + type: object + properties: + appId: + type: string + description: Associated App Id for App Tasks + appVersion: + type: integer + description: Associated App Version for App Tasks + format: int32 + creationTime: + type: string + format: date-time + creatorUserId: + type: integer + format: int64 + id: + type: integer + format: int64 ArgumentMetadata: type: object properties: @@ -23347,6 +23981,96 @@ components: type: string Output: type: string + AssetCreatedEvent: + type: object + properties: + name: + type: string + description: + type: string + key: + type: string + format: uuid + assetType: + type: string + description: Defines what type of value is stored by an asset. + enum: + - DBConnectionString + - HttpConnectionString + - Text + - Bool + - Integer + - Credential + - WindowsCredential + - KeyValueList + x-ms-enum: + name: AssetCreatedEventAssetType + modelAsString: false + assetScope: + type: string + description: Defines the visibility level of an asset. + enum: + - Global + - PerRobot + x-ms-enum: + name: AssetCreatedEventAssetScope + modelAsString: false + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object + AssetDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + assetType: + type: string + description: Defines what type of value is stored by an asset. + enum: + - DBConnectionString + - HttpConnectionString + - Text + - Bool + - Integer + - Credential + - WindowsCredential + - KeyValueList + x-ms-enum: + name: AssetDeletedEventAssetType + modelAsString: false + assetScope: + type: string + description: Defines the visibility level of an asset. + enum: + - Global + - PerRobot + x-ms-enum: + name: AssetDeletedEventAssetScope + modelAsString: false + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object AssetDto: required: - Name @@ -23359,6 +24083,7 @@ components: format: uuid Name: maxLength: 256 + minLength: 1 type: string description: A custom name for the asset. CanBeDeleted: @@ -23549,26 +24274,54 @@ components: type: integer format: int64 description: Stores the value of an asset associated with a robot as well as the robot association data. - AssetsGetRobotByNameAndKeyRequest: - required: - - assetName - - robotKey + AssetUpdatedEvent: type: object properties: - robotKey: + name: type: string - assetName: + description: type: string - AssetsSetRobotAssetsByKeyRequest: - required: - - robotAsset - - robotKey - type: object - properties: - robotKey: + key: type: string - robotAsset: - $ref: '#/components/schemas/RobotAssetDto' + format: uuid + assetType: + type: string + description: Defines what type of value is stored by an asset. + enum: + - DBConnectionString + - HttpConnectionString + - Text + - Bool + - Integer + - Credential + - WindowsCredential + - KeyValueList + x-ms-enum: + name: AssetUpdatedEventAssetType + modelAsString: false + assetScope: + type: string + description: Defines the visibility level of an asset. + enum: + - Global + - PerRobot + x-ms-enum: + name: AssetUpdatedEventAssetScope + modelAsString: false + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + folderKeys: + type: array + items: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object AssetUserValueDto: type: object properties: @@ -23639,6 +24392,29 @@ components: type: integer format: int64 description: Stores the value of an asset associated with a user. + AssetsGetRobotByNameAndKeyRequest: + required: + - assetName + - robotKey + type: object + properties: + robotKey: + minLength: 1 + type: string + assetName: + minLength: 1 + type: string + AssetsSetRobotAssetsByKeyRequest: + required: + - robotAsset + - robotKey + type: object + properties: + robotKey: + minLength: 1 + type: string + robotAsset: + $ref: '#/components/schemas/RobotAssetDto' AttendedRobotDto: type: object properties: @@ -23940,6 +24716,8 @@ components: type: string Verb: type: string + RequiresAuth: + type: boolean Headers: $ref: '#/components/schemas/ResponseDictionaryDto' BlobFileDto: @@ -24047,12 +24825,15 @@ components: type: integer format: int64 versionNumber: + minLength: 1 type: string testCaseUniqueIds: type: array items: type: string format: uuid + enableCoverage: + type: boolean BulkAddQueueItemsRequest: required: - commitType @@ -24060,6 +24841,7 @@ components: type: object properties: queueName: + minLength: 1 type: string commitType: type: string @@ -24198,6 +24980,7 @@ components: type: object properties: action: + minLength: 1 type: string description: Action taken on this task taskIds: @@ -24293,6 +25076,7 @@ components: type: object properties: calendarName: + minLength: 1 type: string CloudTemplateDto: description: The cloud template that hosts the Robot @@ -24370,37 +25154,6 @@ components: x-ms-enum: name: CredentialSetDefaultStoreForResourceTypeRequestResourceType modelAsString: false - CredentialsProxyResourceDto: - required: - - CredentialStoreId - - CredentialStoreName - - Name - - Type - type: object - properties: - Name: - type: string - Type: - type: string - description: This enum describes the type of resources that can be affiliated to a Credentials Proxy. - enum: - - AssetCredential - - RobotCredential - - BucketCredential - - Secrets - - CredentialStore - x-ms-enum: - name: CredentialsProxyResourceDtoType - modelAsString: false - CredentialStoreId: - type: integer - format: int64 - CredentialStoreName: - type: string - Id: - type: integer - format: int64 - description: Defines the resources such as credential stores, assets, robots or bucket for a Credentials Proxy. CredentialStoreDetailsDto: type: object properties: @@ -24417,11 +25170,21 @@ components: ProxyId: type: integer format: int64 + ProxyType: + type: string + enum: + - Connected + - Disconnected + x-ms-enum: + name: CredentialStoreDtoProxyType + modelAsString: false HostName: type: string Name: + minLength: 1 type: string Type: + minLength: 1 type: string AdditionalConfiguration: type: string @@ -24444,6 +25207,7 @@ components: type: object properties: Name: + minLength: 1 type: string Type: type: string @@ -24460,6 +25224,39 @@ components: type: integer format: int64 description: Defines the resources such as assets, robots or bucket for a Credential Store. + CredentialsProxyResourceDto: + required: + - CredentialStoreId + - CredentialStoreName + - Name + - Type + type: object + properties: + Name: + minLength: 1 + type: string + Type: + type: string + description: This enum describes the type of resources that can be affiliated to a Credentials Proxy. + enum: + - AssetCredential + - RobotCredential + - BucketCredential + - Secrets + - CredentialStore + x-ms-enum: + name: CredentialsProxyResourceDtoType + modelAsString: false + CredentialStoreId: + type: integer + format: int64 + CredentialStoreName: + minLength: 1 + type: string + Id: + type: integer + format: int64 + description: Defines the resources such as credential stores, assets, robots or bucket for a Credentials Proxy. CustomEventDto: required: - EventId @@ -24468,6 +25265,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -24726,6 +25524,7 @@ components: type: object properties: robotId: + minLength: 1 type: string EnvironmentsSetRobotsRequest: required: @@ -24908,6 +25707,7 @@ components: format: uuid DisplayName: maxLength: 115 + minLength: 1 type: string description: Display name for the folder. FullyQualifiedName: @@ -25209,8 +26009,8 @@ components: - MachineKeyCannotChange - TenantIdMismatch - UserDoesNotHaveRobot - - NoDefaultAutoScalingProfile - - InvalidAutoScalingProfileSchedule + - RobotDisabled + - UnattendedRobotNotFound - CannotPropagateMachineToSubfolders - MachineRuntimeProtected - IncompatibleOS @@ -25225,6 +26025,7 @@ components: - SameRobotUsernameMappedToDiferentUser - ClassicCannotCleanNotFailedMigrations - InvalidSlots + - RobotNotFoundByKey - InvalidJobKey - MachineSessionNotFound - EnvironmentDeploymentConflict @@ -25332,6 +26133,7 @@ components: - CyberArkEditPasswordNotAllowed - LogMessageNotFound - LogRobotNameNotFound + - InvalidElasticQuery - EncryptionKeyNotFound - EncryptionKeyIncorrectFormat - AzureKeyVaultRetrieveIssue @@ -25405,6 +26207,7 @@ components: - JobAssignedToDifferentRobot - JobNotCompleted - JobVideoRecordingNotEnabled + - QueueItemVideoRecordingNotEnabled - CannotDeleteDefaultCredentialStore - CredentialStoreNotFound - UnknownCredentialStoreType @@ -25413,6 +26216,7 @@ components: - FailedToWriteToCredentialStore - CannotDeleteNonEmptyCredentialStore - FailedToDeleteFromCredentialStore + - InvalidCredentialStoreType - TaskAssignmentError - TaskCompletionError - TaskAssigneeMismatchError @@ -25468,6 +26272,17 @@ components: - TasksSummaryDateDiffOutOfRange - TasksSummaryEndDateShouldBeGreater - TaskDefinitionPropertiesRequired + - TaskDefinitionNotFound + - TaskDefinitionVersionNotFound + - AppTaskNoAction + - AppTaskInvalidPayload + - AppTaskNoData + - TaskProviderInvalidModifiedDate + - TaskProviderInvalidTaskUrn + - TaskDefinitionAllowedActionsRequired + - AppTaskDataItemViolatesContentJsonSchema + - TaskDefinitionSchemaNotAnObject + - TaskDefinitionNameIsAlreadyUsed - InvalidSecureStoreContext - MailSmtpSettingsError - CannotDeleteCalendarWhenUsedBySchedule @@ -25625,6 +26440,12 @@ components: - CredentialsProxyRequestFailedInvalidCredentials - CredentialsProxyConnectionRefused - CredentialsProxyTypeCannotBeUpdated + - CredentialsProxyRequestFailedForbidden + - CredentialsProxyRequestFailedNotFound + - CredentialsProxyRequestFailedInternalServerError + - CredentialsProxyRequestFailedUnhandledError + - CredentialsProxyRequestFailedBadRequest + - CredentialsProxyTypeCannotBeCreated - ServerlessCreateMachineTemplateErrorCode - ServerlessUpdateMachineTemplateErrorCode - ServerlessDeleteMachineTemplateErrorCode @@ -25643,9 +26464,20 @@ components: - SolutionsResourceNotFound - SolutionsResourceNotSupported - SolutionsResourcesNotFound + - FolderKeyRequired + - SolutionsCannotInstallInClassicFolder + - SolutionsCannotInstallInSolutionFolder + - SolutionIsNotInstallAtPath + - SolutionFolderNotFound + - SolutionFolderHasJobsNotInFinalState + - SolutionFileNotFound + - SolutionPackageUrlIsInvalid - ExportTimeout - InvalidMessageReceived - IntegrationServiceApiFailure + - JobFaulted + - JobStopped + - JobUnknownFinalStatus - ContentLengthTooLarge x-ms-enum: name: FailedQueueItemDtoErrorCode @@ -25668,6 +26500,13 @@ components: properties: assignments: $ref: '#/components/schemas/MachineAssignmentsDto' + FolderAssignUsersRequest: + required: + - assignments + type: object + properties: + assignments: + $ref: '#/components/schemas/UserAssignmentsDto' FolderAssignmentsDto: type: object properties: @@ -25677,13 +26516,51 @@ components: type: array items: $ref: '#/components/schemas/RoleUsersDto' - FolderAssignUsersRequest: - required: - - assignments + FolderCreatedEvent: type: object properties: - assignments: - $ref: '#/components/schemas/UserAssignmentsDto' + id: + type: integer + format: int64 + key: + type: string + format: uuid + displayName: + type: string + description: + type: string + code: + type: string + path: + type: string + fullyQualifiedName: + type: string + type: + type: string + enum: + - Standard + - Personal + - Virtual + - Solution + x-ms-enum: + name: FolderCreatedEventType + modelAsString: false + eventTime: + type: string + format: date-time + eventSource: + type: object + FolderDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object FolderDto: required: - DisplayName @@ -25695,6 +26572,7 @@ components: format: uuid DisplayName: maxLength: 115 + minLength: 1 type: string description: Display name for the folder. FullyQualifiedName: @@ -25814,6 +26692,40 @@ components: type: integer format: int32 description: Association between a folder and a set of roles. + FolderUpdatedEvent: + type: object + properties: + id: + type: integer + format: int64 + key: + type: string + format: uuid + displayName: + type: string + description: + type: string + code: + type: string + path: + type: string + fullyQualifiedName: + type: string + type: + type: string + enum: + - Standard + - Personal + - Virtual + - Solution + x-ms-enum: + name: FolderUpdatedEventType + modelAsString: false + eventTime: + type: string + format: date-time + eventSource: + type: object FormTaskCreateRequest: required: - title @@ -25995,6 +26907,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -26095,6 +27008,7 @@ components: - StudioDesktop - AutomationOpsPipelines - Apps + - SAP x-ms-enum: name: JobDtoSourceType modelAsString: false @@ -26258,6 +27172,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -26288,51 +27203,7 @@ components: format: int64 description: This event is raised whenever a job has failed to finish execution x-webhook-event: job.faulted - JobsCreatedEventDto: - required: - - EventId - - Timestamp - - Type - type: object - properties: - Type: - type: string - EventId: - maxLength: 50 - minLength: 0 - type: string - EntityKey: - type: string - format: uuid - Timestamp: - type: string - format: date-time - StartInfo: - $ref: '#/components/schemas/WebhookStartProcessDto' - Jobs: - type: array - description: List of jobs that were created and are in pending state - readOnly: true - items: - $ref: '#/components/schemas/WebhookJobDto' - EventTime: - type: string - format: date-time - TenantId: - type: integer - format: int32 - OrganizationUnitId: - type: integer - format: int64 - OrganizationUnitKey: - type: string - format: uuid - UserId: - type: integer - format: int64 - description: This event is raised whenever jobs were created and queued for execution - x-webhook-event: job.created - JobsStoppedEventDto: + JobResumedEventDto: required: - EventId - Timestamp @@ -26340,6 +27211,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -26351,10 +27223,8 @@ components: Timestamp: type: string format: date-time - Jobs: - type: array - items: - $ref: '#/components/schemas/SimpleJobEventDto' + Job: + $ref: '#/components/schemas/SimpleJobEventDto' EventTime: type: string format: date-time @@ -26370,8 +27240,7 @@ components: UserId: type: integer format: int64 - description: This event is raised whenever jobs were stopped - x-webhook-event: job.stopped + x-webhook-event: job.resumed JobStartedEventDto: required: - EventId @@ -26380,6 +27249,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -26410,6 +27280,44 @@ components: format: int64 description: This event is raised whenever a job has started execution on a robot x-webhook-event: job.started + JobStoppingEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + Job: + $ref: '#/components/schemas/SimpleJobEventDto' + EventTime: + type: string + format: date-time + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + x-webhook-event: job.stopping JobSuspendedEventDto: required: - EventId @@ -26418,6 +27326,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -26448,6 +27357,44 @@ components: format: int64 description: This event is raised whenever a job has suspended execution on a robot x-webhook-event: job.suspended + JobTerminatingEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + Job: + $ref: '#/components/schemas/SimpleJobEventDto' + EventTime: + type: string + format: date-time + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + x-webhook-event: job.terminating JobTriggerDto: type: object properties: @@ -26463,6 +27410,7 @@ components: - Job - Task - Timer + - Integration x-ms-enum: name: JobTriggerDtoTriggerType modelAsString: false @@ -26511,6 +27459,7 @@ components: - Job - Task - Timer + - Integration x-ms-enum: name: JobTriggerWaitEventModelTriggerType modelAsString: false @@ -26562,6 +27511,92 @@ components: type: string description: Modification time of the item format: date-time + JobsCreatedEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + StartInfo: + $ref: '#/components/schemas/WrappedStartProcessDto' + Jobs: + type: array + description: List of jobs that were created and are in pending state + readOnly: true + items: + $ref: '#/components/schemas/WrappedJobDto' + EventTime: + type: string + format: date-time + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + description: This event is raised whenever jobs were created and queued for execution + x-webhook-event: job.created + JobsStoppedEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + Jobs: + type: array + items: + $ref: '#/components/schemas/SimpleJobEventDto' + EventTime: + type: string + format: date-time + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + description: This event is raised whenever jobs were stopped + x-webhook-event: job.stopped KeyValuePairOfStringString: type: object properties: @@ -26792,8 +27827,10 @@ components: type: object properties: licenseKey: + minLength: 1 type: string environment: + minLength: 1 type: string email: type: string @@ -26926,6 +27963,7 @@ components: type: object properties: key: + minLength: 1 type: string robotType: type: string @@ -27036,6 +28074,10 @@ components: type: integer description: The Id of the Machine on which the Robot that generated the log is running. format: int64 + MachineKey: + type: string + description: The Key of the Machine on which the Robot that generated the log is running. + format: uuid RuntimeType: type: string description: The RuntimeType of the job referenced by the JobKey field @@ -27074,8 +28116,10 @@ components: tenancyName: type: string usernameOrEmailAddress: + minLength: 1 type: string password: + minLength: 1 type: string LongVersionedEntity: type: object @@ -27196,18 +28240,6 @@ components: description: Robots assigned to template machine. items: $ref: '#/components/schemas/RobotUserDto' - AutoScalingProfile: - type: string - description: The profile that drives auto scaling. - enum: - - CostEfficient - - Balanced - - Fast - - Custom - - Always - x-ms-enum: - name: MachineDtoAutoScalingProfile - modelAsString: false AutomationType: type: string description: The automation type the machine supports. @@ -27441,6 +28473,14 @@ components: format: int64 MachineName: type: string + MaintenanceMode: + type: string + enum: + - Default + - Enabled + x-ms-enum: + name: MachineSessionRuntimeDtoMaintenanceMode + modelAsString: false HostMachineName: type: string RuntimeType: @@ -27529,6 +28569,11 @@ components: TriggersCount: type: integer format: int32 + MachineVpnSettingsDto: + type: object + properties: + cidr: + type: string MachinesFolderAssociationsDto: type: object properties: @@ -27559,11 +28604,6 @@ components: type: integer description: The Id of the Machine. format: int64 - MachineVpnSettingsDto: - type: object - properties: - cidr: - type: string MaintenanceSetting: type: object properties: @@ -27638,21 +28678,6 @@ components: description: The next execution time of the maintenance window format: date-time description: Represents a maintenance window for a cloud machine - MessageTemplateDto: - required: - - Name - type: object - properties: - Name: - maxLength: 256 - type: string - description: The name of a specific template (e.g. Templates.LoginLayout). - Value: - type: string - description: The value assigned to a specific template. - Id: - type: string - description: Used to store various predefined application message templates like custom login layout. MoveFolderMachineChange: type: object properties: @@ -27760,27 +28785,27 @@ components: type: array items: $ref: '#/components/schemas/ConfigurationEntry' - ODataValueOfIEnumerableOfCredentialsProxyResourceDto: + ODataValueOfIEnumerableOfCredentialStoreDto: type: object properties: value: type: array items: - $ref: '#/components/schemas/CredentialsProxyResourceDto' - ODataValueOfIEnumerableOfCredentialStoreDto: + $ref: '#/components/schemas/CredentialStoreDto' + ODataValueOfIEnumerableOfCredentialStoreResourceDto: type: object properties: value: type: array items: - $ref: '#/components/schemas/CredentialStoreDto' - ODataValueOfIEnumerableOfCredentialStoreResourceDto: + $ref: '#/components/schemas/CredentialStoreResourceDto' + ODataValueOfIEnumerableOfCredentialsProxyResourceDto: type: object properties: value: type: array items: - $ref: '#/components/schemas/CredentialStoreResourceDto' + $ref: '#/components/schemas/CredentialsProxyResourceDto' ODataValueOfIEnumerableOfEnvironmentDto: type: object properties: @@ -27929,13 +28954,6 @@ components: type: array items: $ref: '#/components/schemas/MachineSessionRuntimeDto' - ODataValueOfIEnumerableOfMessageTemplateDto: - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/MessageTemplateDto' ODataValueOfIEnumerableOfMoveFolderMachineChange: type: object properties: @@ -28104,6 +29122,13 @@ components: type: array items: $ref: '#/components/schemas/TaskCatalogDto' + ODataValueOfIEnumerableOfTaskDefinitionDto: + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/TaskDefinitionDto' ODataValueOfIEnumerableOfTaskDto: type: object properties: @@ -28241,12 +29266,69 @@ components: properties: DisplayName: maxLength: 128 + minLength: 1 type: string description: The name of the organization unit. Id: 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." + PackageDeletedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + version: + type: string + feedId: + type: string + format: uuid + eventTime: + type: string + format: date-time + eventSource: + type: object + PackageUploadedEvent: + type: object + properties: + key: + type: string + format: uuid + name: + type: string + version: + type: string + feedId: + type: string + format: uuid + type: + type: string + enum: + - Undefined + - Processes + - Libraries + - PersonalWorkspace + - FolderHierarchy + x-ms-enum: + name: PackageUploadedEventType + modelAsString: false + description: + type: string + folderKey: + type: string + format: uuid + tags: + type: array + items: + $ref: '#/components/schemas/TagDto' + eventTime: + type: string + format: date-time + eventSource: + type: object PageResultDtoOfFolderDto: type: object properties: @@ -28316,6 +29398,7 @@ components: type: object properties: folderName: + minLength: 1 type: string PingEventDto: required: @@ -28325,6 +29408,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -28485,42 +29569,6 @@ components: Id: type: string description: A process is a project defined in UiPath Studio and published in Orchestrator from UiPath Studio or manually. - ProcessesSetArgumentsRequest: - required: - - arguments - - key - type: object - properties: - key: - type: string - arguments: - $ref: '#/components/schemas/ArgumentMetadata' - ProcessingExceptionDto: - type: object - properties: - Reason: - type: string - description: The reason the processing failed. - Details: - type: string - description: Stores additional details about the exception. - Type: - type: string - description: The processing exception type, if any. - enum: - - ApplicationException - - BusinessException - x-ms-enum: - name: ProcessingExceptionDtoType - modelAsString: false - AssociatedImageFilePath: - type: string - description: A path on the robot running computer to an image file that stores relevant information about the exception - e.g. a system print screen. - CreationTime: - type: string - description: Time when the exception occurred - format: date-time - description: Stores information about exceptions thrown while processing failed queue items. ProcessScheduleDto: required: - Name @@ -28536,6 +29584,7 @@ components: description: Specifies if the schedule is active or not. Name: maxLength: 255 + minLength: 1 type: string description: The name of the schedule. ReleaseId: @@ -28644,6 +29693,7 @@ components: format: uuid TimeZoneId: maxLength: 80 + minLength: 1 type: string description: The timezone under which the schedule will run. TimeZoneIana: @@ -28674,6 +29724,9 @@ components: QueueDefinitionName: type: string description: The Name of the queue that uses this schedule for activation (trigger jobs when new queue items are added) + ActivateOnJobComplete: + type: boolean + description: Flag for activating the queue trigger on each completed job. ItemsActivationThreshold: maximum: 1E+4 minimum: 1 @@ -28739,6 +29792,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -28751,7 +29805,7 @@ components: type: string format: date-time ProcessSchedule: - $ref: '#/components/schemas/WebhookProcessScheduleDto' + $ref: '#/components/schemas/WrappedProcessScheduleDto' Reason: type: string readOnly: true @@ -28805,6 +29859,43 @@ components: type: boolean AlwaysRunning: type: boolean + ProcessesSetArgumentsRequest: + required: + - arguments + - key + type: object + properties: + key: + minLength: 1 + type: string + arguments: + $ref: '#/components/schemas/ArgumentMetadata' + ProcessingExceptionDto: + type: object + properties: + Reason: + type: string + description: The reason the processing failed. + Details: + type: string + description: Stores additional details about the exception. + Type: + type: string + description: The processing exception type, if any. + enum: + - ApplicationException + - BusinessException + x-ms-enum: + name: ProcessingExceptionDtoType + modelAsString: false + AssociatedImageFilePath: + type: string + description: A path on the robot running computer to an image file that stores relevant information about the exception - e.g. a system print screen. + CreationTime: + type: string + description: Time when the exception occurred + format: date-time + description: Stores information about exceptions thrown while processing failed queue items. QueueCreatedEventDto: required: - EventId @@ -28813,6 +29904,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -28860,6 +29952,7 @@ components: description: A unique identifier associated to each queue. format: uuid Name: + minLength: 1 type: string description: A custom name for the queue. Description: @@ -28986,6 +30079,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -29049,6 +30143,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -29122,6 +30217,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -29195,6 +30291,12 @@ components: Progress: type: string description: String field which is used to keep track of the business flow progress. + Source: + maxLength: 20 + minLength: 0 + pattern: Manual|Apps + type: string + description: The Source type of the item. description: Defines the work item content. QueueItemDeleteBulkRequest: type: object @@ -29331,6 +30433,9 @@ components: type: integer description: "The number of times this work item has been processed.\r\nThis can be higher than 0 only if MaxRetried number is set and the item processing failed at least once with ApplicationException." format: int32 + HasVideoRecorded: + type: boolean + description: True if any execution video has been recorded for this queue item, false otherwise. SpecificData: type: string description: A JSON representation of the specific content. @@ -29439,6 +30544,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -29471,49 +30577,6 @@ components: format: int64 description: This event is raised whenever a queue item transaction has failed x-webhook-event: queueItem.transactionFailed - QueueItemsAbandonedEventDto: - required: - - EventId - - Timestamp - - Type - type: object - properties: - Type: - type: string - EventId: - maxLength: 50 - minLength: 0 - type: string - EntityKey: - type: string - format: uuid - Timestamp: - type: string - format: date-time - Queue: - $ref: '#/components/schemas/QueueDefinitionEventDto' - QueueItems: - type: array - readOnly: true - items: - $ref: '#/components/schemas/QueueItemSimpleEventDto' - EventTime: - type: string - format: date-time - TenantId: - type: integer - format: int32 - OrganizationUnitId: - type: integer - format: int64 - OrganizationUnitKey: - type: string - format: uuid - UserId: - type: integer - format: int64 - description: This event is raised whenever queue item transactions have expired and were abandoned - x-webhook-event: queueItem.transactionAbandoned QueueItemSimpleEventDto: type: object properties: @@ -29563,7 +30626,7 @@ components: name: QueueItemSimpleEventDtoReviewStatus modelAsString: false ProcessingException: - $ref: '#/components/schemas/WebhookProcessingExceptionDto' + $ref: '#/components/schemas/WrappedProcessingExceptionDto' DueDate: type: string description: The latest date and time at which the item should be processed. If empty the item can be processed at any given time. @@ -29645,7 +30708,7 @@ components: format: int64 readOnly: true Robot: - $ref: '#/components/schemas/WebhookRobotDto' + $ref: '#/components/schemas/WrappedRobotDto' ReviewerUser: $ref: '#/components/schemas/WebhookSimpleUserDto' SpecificContent: @@ -29660,6 +30723,10 @@ components: type: object description: A collection of key value pairs containing custom data resulted after successful processing. readOnly: true + Source: + type: string + description: Where the queue item was created + readOnly: true QueueItemStartedEventDto: required: - EventId @@ -29668,6 +30735,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -29700,6 +30768,50 @@ components: format: int64 description: This event is raised whenever a new queue item transaction is started x-webhook-event: queueItem.transactionStarted + QueueItemsAbandonedEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + Queue: + $ref: '#/components/schemas/QueueDefinitionEventDto' + QueueItems: + type: array + readOnly: true + items: + $ref: '#/components/schemas/QueueItemSimpleEventDto' + EventTime: + type: string + format: date-time + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + description: This event is raised whenever queue item transactions have expired and were abandoned + x-webhook-event: queueItem.transactionAbandoned QueueProcessingRecordDto: type: object properties: @@ -29900,27 +31012,28 @@ components: BucketId: type: integer format: int64 - QueueSetItemReviewerRequest: + QueueSetItemReviewStatusRequest: required: - queueItems - - userId + - status type: object properties: - userId: - type: integer - format: int64 + status: + minLength: 1 + type: string queueItems: type: array items: $ref: '#/components/schemas/LongVersionedEntity' - QueueSetItemReviewStatusRequest: + QueueSetItemReviewerRequest: required: - queueItems - - status + - userId type: object properties: - status: - type: string + userId: + type: integer + format: int64 queueItems: type: array items: @@ -29937,13 +31050,6 @@ components: properties: transactionResult: $ref: '#/components/schemas/TransactionResultDto' - QueuesStartTransactionRequest: - required: - - transactionData - type: object - properties: - transactionData: - $ref: '#/components/schemas/TransactionDataDto' QueueUnsetItemReviewerRequest: required: - queueItems @@ -29961,6 +31067,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -29998,6 +31105,13 @@ components: format: int64 description: This event is raised whenever queue definitions were updated x-webhook-event: queue.updated + QueuesStartTransactionRequest: + required: + - transactionData + type: object + properties: + transactionData: + $ref: '#/components/schemas/TransactionDataDto' RaiseProcessAlertRequest: required: - processAlert @@ -30047,6 +31161,8 @@ components: x-ms-enum: name: ReexecuteTestCasesOptionsDtoRuntimeType modelAsString: false + enforceExecutionOrder: + type: boolean ReleaseCreatedEventDto: required: - EventId @@ -30055,6 +31171,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -30070,7 +31187,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookReleaseDto' + $ref: '#/components/schemas/WrappedReleaseDto' EventTime: type: string format: date-time @@ -30100,6 +31217,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -30115,7 +31233,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookReleaseDto' + $ref: '#/components/schemas/WrappedReleaseDto' EventTime: type: string format: date-time @@ -30148,9 +31266,11 @@ components: type: string description: A unique identifier associated to each release. ProcessKey: + minLength: 1 type: string description: The unique identifier of the process associated with the release. ProcessVersion: + minLength: 1 type: string description: The version of the process associated with the release. IsLatestVersion: @@ -30163,6 +31283,7 @@ components: type: string description: Used to add additional information about a release in order to better identify it. Name: + minLength: 1 type: string description: A custom name of the release. The default name format is ProcessName_EnvironmentName. EnvironmentId: @@ -30177,6 +31298,8 @@ components: EntryPointId: type: integer format: int64 + EntryPointPath: + type: string EntryPoint: $ref: '#/components/schemas/EntryPointDto' InputArguments: @@ -30217,6 +31340,8 @@ components: $ref: '#/components/schemas/VideoRecordingSettingsDto' AutoUpdate: type: boolean + HiddenForAttendedUser: + type: boolean FeedId: type: string format: uuid @@ -30312,25 +31437,6 @@ components: BucketId: type: integer format: int64 - ReleasesUpdateToLatestPackageVersionBulkRequest: - required: - - releaseIds - type: object - properties: - releaseIds: - type: array - items: - type: integer - format: int64 - mergePackageTags: - type: boolean - ReleasesUpdateToSpecificPackageVersionRequest: - required: - - packageVersion - type: object - properties: - packageVersion: - type: string ReleaseUpdatedEventDto: required: - EventId @@ -30339,6 +31445,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -30354,7 +31461,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookReleaseDto' + $ref: '#/components/schemas/WrappedReleaseDto' EventTime: type: string format: date-time @@ -30388,6 +31495,7 @@ components: format: int64 VersionNumber: maxLength: 50 + minLength: 1 type: string description: The version of process associated with the release. CreationTime: @@ -30401,6 +31509,26 @@ components: type: integer format: int64 description: "Stores data about a version of the various versions of the process associated with a certain release.\r\nIf a certain version is associated on and off with a release a new ReleaseVersion object is created for each association." + ReleasesUpdateToLatestPackageVersionBulkRequest: + required: + - releaseIds + type: object + properties: + releaseIds: + type: array + items: + type: integer + format: int64 + mergePackageTags: + type: boolean + ReleasesUpdateToSpecificPackageVersionRequest: + required: + - packageVersion + type: object + properties: + packageVersion: + minLength: 1 + type: string RemoveMachinesFromFolderRequest: required: - machineIds @@ -30445,11 +31573,13 @@ components: - TimeTrigger - EventTrigger - QueueTrigger + - AppsTrigger - Property x-ms-enum: name: ResourceOverwriteDto`1ResourceType modelAsString: false resourceKey: + minLength: 1 type: string description: The key of the resource to be overwritten entityId: @@ -30502,6 +31632,7 @@ components: properties: Name: maxLength: 128 + minLength: 1 type: string description: The asset name. ValueType: @@ -30562,6 +31693,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -30577,7 +31709,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookRobotDto' + $ref: '#/components/schemas/WrappedRobotDto' EventTime: type: string format: date-time @@ -30617,6 +31749,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -30632,7 +31765,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookRobotDto' + $ref: '#/components/schemas/WrappedRobotDto' EventTime: type: string format: date-time @@ -30832,37 +31965,78 @@ components: type: integer format: int64 description: Entity that represents an acquired Robot license - RobotsConvertToFloatingRequest: + RobotUpdatedEventDto: required: - - robotId + - EventId + - Timestamp + - Type type: object properties: - robotId: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + Robots: + type: array + readOnly: true + items: + $ref: '#/components/schemas/WrappedRobotDto' + EventTime: + type: string + format: date-time + EventSourceId: type: integer format: int64 - RobotsFromFolderModel: + readOnly: true + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + description: This event is raised whenever robots were updated + x-webhook-event: robot.updated + RobotUserDto: + required: + - RobotId + type: object + properties: + UserName: + type: string + description: The name of the user. + RobotId: + type: integer + description: The Id of the Robot. + format: int64 + HasTriggers: + type: boolean + description: Whether the machine robot has triggers defined or not. + RobotWithLicenseDto: required: - HostingType - Name - Type type: object properties: - UserType: - type: string - enum: - - User - - Robot - - DirectoryUser - - DirectoryGroup - - DirectoryRobot - - DirectoryExternalApplication - x-ms-enum: - name: RobotsFromFolderModelUserType - modelAsString: false - UserEmail: - type: string - UserFullName: - type: string + License: + $ref: '#/components/schemas/RobotLicenseDto' + User: + $ref: '#/components/schemas/UserDto' LicenseKey: maxLength: 255 minLength: 0 @@ -31002,90 +32176,38 @@ components: Id: type: integer format: int64 - RobotsToggleEnabledStatusRequest: - required: - - enabled - - robotIds - type: object - properties: - robotIds: - type: array - items: - type: integer - format: int64 - enabled: - type: boolean - RobotUpdatedEventDto: - required: - - EventId - - Timestamp - - Type - type: object - properties: - Type: - type: string - EventId: - maxLength: 50 - minLength: 0 - type: string - EntityKey: - type: string - format: uuid - Timestamp: - type: string - format: date-time - Robots: - type: array - readOnly: true - items: - $ref: '#/components/schemas/WebhookRobotDto' - EventTime: - type: string - format: date-time - EventSourceId: - type: integer - format: int64 - readOnly: true - TenantId: - type: integer - format: int32 - OrganizationUnitId: - type: integer - format: int64 - OrganizationUnitKey: - type: string - format: uuid - UserId: - type: integer - format: int64 - description: This event is raised whenever robots were updated - x-webhook-event: robot.updated - RobotUserDto: + description: Entity derived from RobotDto. Is shares all the properties of the base entity and includes the license field. + RobotsConvertToFloatingRequest: required: - - RobotId + - robotId type: object properties: - UserName: - type: string - description: The name of the user. - RobotId: + robotId: type: integer - description: The Id of the Robot. format: int64 - HasTriggers: - type: boolean - description: Whether the machine robot has triggers defined or not. - RobotWithLicenseDto: + RobotsFromFolderModel: required: - HostingType - Name - Type type: object properties: - License: - $ref: '#/components/schemas/RobotLicenseDto' - User: - $ref: '#/components/schemas/UserDto' + UserType: + type: string + enum: + - User + - Robot + - DirectoryUser + - DirectoryGroup + - DirectoryRobot + - DirectoryExternalApplication + x-ms-enum: + name: RobotsFromFolderModelUserType + modelAsString: false + UserEmail: + type: string + UserFullName: + type: string LicenseKey: maxLength: 255 minLength: 0 @@ -31225,7 +32347,19 @@ components: Id: type: integer format: int64 - description: Entity derived from RobotDto. Is shares all the properties of the base entity and includes the license field. + RobotsToggleEnabledStatusRequest: + required: + - enabled + - robotIds + type: object + properties: + robotIds: + type: array + items: + type: integer + format: int64 + enabled: + type: boolean RoleDto: type: object properties: @@ -31450,16 +32584,28 @@ components: x-ms-enum: name: SessionEventDataLicenseErrorCode modelAsString: false - SessionsToggleMachineSessionDebugModeRequest: - required: - - enabled + SessionMaintenanceModeParameters: type: object properties: - enabled: - type: boolean - minutes: + sessionId: type: integer - format: int32 + format: int64 + maintenanceMode: + type: string + enum: + - Default + - Enabled + x-ms-enum: + name: SessionMaintenanceModeParametersMaintenanceMode + modelAsString: false + stopJobsStrategy: + type: string + enum: + - SoftStop + - Kill + x-ms-enum: + name: SessionMaintenanceModeParametersStopJobsStrategy + modelAsString: false SessionUpdatedEventDto: required: - EventId @@ -31468,6 +32614,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -31505,6 +32652,32 @@ components: format: int64 description: This event is raised whenever robot's session has changed x-webhook-event: robot.status + SessionsToggleMachineSessionDebugModeRequest: + required: + - enabled + type: object + properties: + enabled: + type: boolean + minutes: + type: integer + format: int32 + SetUsersRequest: + required: + - addedUserIds + - removedUserIds + type: object + properties: + addedUserIds: + type: array + items: + type: integer + format: int64 + removedUserIds: + type: array + items: + type: integer + format: int64 SettingsDeleteBulkRequest: type: object properties: @@ -31519,6 +32692,7 @@ components: properties: Name: maxLength: 128 + minLength: 1 type: string description: The name of a specific setting (e.g. Abp.Net.Mail.DefaultFromAddress). Value: @@ -31545,22 +32719,6 @@ components: type: array items: $ref: '#/components/schemas/SettingsDto' - SetUsersRequest: - required: - - addedUserIds - - removedUserIds - type: object - properties: - addedUserIds: - type: array - items: - type: integer - format: int64 - removedUserIds: - type: array - items: - type: integer - format: int64 SignalRActivitySettingsDto: type: object properties: @@ -31592,6 +32750,16 @@ components: type: string format: uuid readOnly: true + Type: + type: string + readOnly: true + enum: + - Unattended + - Attended + - ServerlessGeneric + x-ms-enum: + name: SimpleJobEventDtoType + modelAsString: false State: type: string readOnly: true @@ -31631,6 +32799,47 @@ components: type: integer format: int32 readOnly: true + RuntimeType: + type: string + enum: + - NonProduction + - Attended + - Unattended + - Development + - Studio + - RpaDeveloper + - StudioX + - CitizenDeveloper + - Headless + - RpaDeveloperPro + - StudioPro + - TestAutomation + - AutomationCloud + - Serverless + - AutomationKit + - ServerlessTestAutomation + - AutomationCloudTestAutomation + - AttendedStudioWeb + x-ms-enum: + name: SimpleJobEventDtoRuntimeType + modelAsString: false + SourceType: + type: string + readOnly: true + enum: + - Manual + - Schedule + - Agent + - Queue + - StudioWeb + - IntegrationTrigger + - StudioDesktop + - AutomationOpsPipelines + - Apps + - SAP + x-ms-enum: + name: SimpleJobEventDtoSourceType + modelAsString: false OutputArguments: type: object properties: {} @@ -31638,9 +32847,41 @@ components: Robot: $ref: '#/components/schemas/SimpleRobotEventDto' Machine: - $ref: '#/components/schemas/WebhookSimpleMachineDto' + $ref: '#/components/schemas/SimpleMachineDto' Release: $ref: '#/components/schemas/SimpleReleaseEventDto' + SimpleMachineDto: + type: object + properties: + Id: + type: integer + format: int64 + Key: + type: string + format: uuid + Name: + type: string + ServiceUserName: + type: string + Type: + type: string + enum: + - Standard + - Template + x-ms-enum: + name: SimpleMachineDtoType + modelAsString: false + Scope: + type: string + enum: + - Default + - Shared + - PersonalWorkspace + - Cloud + - Serverless + x-ms-enum: + name: SimpleMachineDtoScope + modelAsString: false SimpleReleaseDto: required: - Name @@ -31652,9 +32893,11 @@ components: type: string description: A unique identifier associated to each release. ProcessKey: + minLength: 1 type: string description: The unique identifier of the process associated with the release. ProcessVersion: + minLength: 1 type: string description: The version of the process associated with the release. IsLatestVersion: @@ -31667,6 +32910,7 @@ components: type: string description: Used to add additional information about a release in order to better identify it. Name: + minLength: 1 type: string description: A custom name of the release. The default name format is ProcessName_EnvironmentName. EnvironmentId: @@ -31681,6 +32925,8 @@ components: EntryPointId: type: integer format: int64 + EntryPointPath: + type: string EntryPoint: $ref: '#/components/schemas/EntryPointDto' InputArguments: @@ -31721,6 +32967,8 @@ components: $ref: '#/components/schemas/VideoRecordingSettingsDto' AutoUpdate: type: boolean + HiddenForAttendedUser: + type: boolean FeedId: type: string format: uuid @@ -31808,7 +33056,7 @@ components: ProcessKey: type: string description: The name of the process - DisplayName: + Name: type: string description: The display name of the process SimpleRobotDto: @@ -32237,6 +33485,7 @@ components: type: object properties: Host: + minLength: 1 type: string Port: type: integer @@ -32344,6 +33593,7 @@ components: - StudioDesktop - AutomationOpsPipelines - Apps + - SAP x-ms-enum: name: StartProcessDtoSource modelAsString: false @@ -32576,6 +33826,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -32706,6 +33957,7 @@ components: properties: Name: maxLength: 50 + minLength: 1 type: string description: Name of the Task Catalog. Description: @@ -32727,6 +33979,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -32779,51 +34032,6 @@ components: action: type: string description: Action taken on this task - TaskCreatedEventDto: - required: - - EventId - - Timestamp - - Type - type: object - properties: - Type: - type: string - EventId: - maxLength: 50 - minLength: 0 - type: string - EntityKey: - type: string - format: uuid - Timestamp: - type: string - format: date-time - Tasks: - type: array - readOnly: true - items: - $ref: '#/components/schemas/WebhookTaskCreatedDto' - EventTime: - type: string - format: date-time - EventSourceId: - type: integer - format: int64 - readOnly: true - TenantId: - type: integer - format: int32 - OrganizationUnitId: - type: integer - format: int64 - OrganizationUnitKey: - type: string - format: uuid - UserId: - type: integer - format: int64 - description: Dto for UiPath.Orchestrator.LedgerEvents.TaskCreated. Gets raised when task is completed - x-webhook-event: task.created TaskCreateRequest: required: - title @@ -32838,6 +34046,7 @@ components: - DocumentValidationTask - DocumentClassificationTask - DataLabelingTask + - AppTask x-ms-enum: name: TaskCreateRequestType modelAsString: false @@ -32873,6 +34082,52 @@ components: description: List of tags associated to the task. items: $ref: '#/components/schemas/TagDto' + TaskCreatedEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + Tasks: + type: array + readOnly: true + items: + $ref: '#/components/schemas/WebhookTaskCreatedDto' + EventTime: + type: string + format: date-time + EventSourceId: + type: integer + format: int64 + readOnly: true + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + description: Dto for UiPath.Orchestrator.LedgerEvents.TaskCreated. Gets raised when task is completed + x-webhook-event: task.created TaskDataDto: type: object properties: @@ -32930,6 +34185,7 @@ components: - DocumentValidationTask - DocumentClassificationTask - DataLabelingTask + - AppTask x-ms-enum: name: TaskMetadataDtoType modelAsString: false @@ -33008,6 +34264,98 @@ components: data: type: object description: Task data json + TaskDefinitionDto: + type: object + properties: + Name: + type: string + description: Name of the Task Definition. + Key: + type: string + description: Unique key for Task Definition + format: uuid + Description: + type: string + description: Description of this task definition. + Properties: + $ref: '#/components/schemas/TaskDefinitionPropertiesDto' + IsDeleted: + type: boolean + DeleterUserId: + type: integer + format: int64 + DeletionTime: + type: string + format: date-time + 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 + description: Task Definition entity for external access + TaskDefinitionPropertiesDto: + type: object + properties: + version: + type: integer + description: Version number of the property set + format: int32 + schema: + type: string + description: Field Schema for the definition + allowedActions: + type: array + description: Set of allowed actions for this version of Task Definition + items: + type: string + allowedActionsForDefinition: + type: string + taskDefinitionKey: + type: string + format: uuid + creationTime: + type: string + format: date-time + creatorUserId: + type: integer + format: int64 + id: + type: integer + format: int64 + description: Task Definition Properties created for a definition + TaskDefinitionPropertiesRequest: + type: object + properties: + schema: + type: string + allowedActions: + type: array + items: + type: string + TaskDefinitionRequest: + type: object + properties: + Name: + maxLength: 50 + type: string + description: Name of the Task Definition. + Description: + maxLength: 512 + type: string + description: Description of this task definition. + Properties: + $ref: '#/components/schemas/TaskDefinitionPropertiesRequest' + description: Task Definition entity for Creating or Updating Task Definition TaskDeletedEventDto: required: - EventId @@ -33016,6 +34364,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -33031,7 +34380,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookTaskDeletedDto' + $ref: '#/components/schemas/WrappedTaskDeletedDto' EventTime: type: string format: date-time @@ -33113,6 +34462,7 @@ components: - DocumentValidationTask - DocumentClassificationTask - DataLabelingTask + - AppTask x-ms-enum: name: TaskMetadataDtoType modelAsString: false @@ -33249,6 +34599,7 @@ components: - DocumentValidationTask - DocumentClassificationTask - DataLabelingTask + - AppTask x-ms-enum: name: TaskMetadataDtoType modelAsString: false @@ -33322,6 +34673,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -33337,7 +34689,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookTaskForwardedDto' + $ref: '#/components/schemas/WrappedTaskForwardedDto' EventTime: type: string format: date-time @@ -33432,15 +34784,6 @@ components: type: string description: Gets or sets the userNameOrEmail for this task operation description: Class to hold error details of an operation (assign/unassign/reassign/delete) on a task. - TasksAssignRequest: - required: - - taskAssignments - type: object - properties: - taskAssignments: - type: array - items: - $ref: '#/components/schemas/TaskAssignmentRequest' TaskSaveAndReassignmentRequest: type: object properties: @@ -33476,6 +34819,7 @@ components: type: object properties: Type: + minLength: 1 type: string EventId: maxLength: 50 @@ -33491,7 +34835,7 @@ components: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookTaskSavedDto' + $ref: '#/components/schemas/WrappedTaskSavedDto' EventTime: type: string format: date-time @@ -33513,16 +34857,6 @@ components: format: int64 description: Dto for UiPath.Orchestrator.LedgerEvents.TaskSaved. Gets raised when task is Saved x-webhook-event: task.saved - TasksDeleteRequest: - required: - - taskIds - type: object - properties: - taskIds: - type: array - items: - type: integer - format: int64 TaskTagsSaveRequest: required: - taskId @@ -33537,6 +34871,25 @@ components: description: Tags collection items: $ref: '#/components/schemas/TagDto' + TasksAssignRequest: + required: + - taskAssignments + type: object + properties: + taskAssignments: + type: array + items: + $ref: '#/components/schemas/TaskAssignmentRequest' + TasksDeleteRequest: + required: + - taskIds + type: object + properties: + taskIds: + type: array + items: + type: integer + format: int64 TenantDto: type: object properties: @@ -33713,6 +35066,7 @@ components: type: integer format: int64 VersionNumber: + minLength: 1 type: string TestSetId: type: integer @@ -33744,6 +35098,9 @@ components: format: int64 inputArguments: type: object + executionOrder: + type: integer + format: int32 TestCaseExecutionAttachmentDto: type: object properties: @@ -33878,6 +35235,9 @@ components: x-ms-enum: name: TestCaseExecutionDtoTestCaseType modelAsString: false + ExecutionOrder: + type: integer + format: int32 Id: type: integer format: int64 @@ -33895,12 +35255,16 @@ components: type: array items: type: object + executionOrder: + type: integer + format: int32 TestDataQueueAddItemDto: required: - queueName type: object properties: queueName: + minLength: 1 type: string content: type: object @@ -33911,6 +35275,7 @@ components: type: object properties: queueName: + minLength: 1 type: string items: type: array @@ -33924,10 +35289,12 @@ components: properties: Name: maxLength: 256 + minLength: 1 type: string Description: type: string ContentJsonSchema: + minLength: 1 type: string ItemsCount: type: integer @@ -33965,6 +35332,7 @@ components: type: object properties: queueName: + minLength: 1 type: string setConsumed: type: boolean @@ -34001,6 +35369,7 @@ components: type: object properties: queueName: + minLength: 1 type: string isConsumed: type: boolean @@ -34056,6 +35425,7 @@ components: type: string format: uuid Name: + minLength: 1 type: string Description: type: string @@ -34219,6 +35589,8 @@ components: type: array items: $ref: '#/components/schemas/TestSetExecutionAttachmentDto' + EnforceExecutionOrder: + type: boolean CreationTime: type: string format: date-time @@ -34282,6 +35654,8 @@ components: machineSessionId: type: integer format: int64 + enforceExecutionOrder: + type: boolean TestSetInputArgumentDto: required: - Name @@ -34290,10 +35664,13 @@ components: type: object properties: Name: + minLength: 1 type: string Type: + minLength: 1 type: string Value: + minLength: 1 type: string LastModificationTime: type: string @@ -34322,8 +35699,10 @@ components: TestSet: $ref: '#/components/schemas/TestSetDto' VersionMask: + minLength: 1 type: string PackageIdentifier: + minLength: 1 type: string IncludePrerelease: type: boolean @@ -34353,6 +35732,7 @@ components: type: boolean Name: maxLength: 256 + minLength: 1 type: string Description: type: string @@ -34363,6 +35743,7 @@ components: type: string TimeZoneId: maxLength: 80 + minLength: 1 type: string TimeZoneIana: type: string @@ -34607,6 +35988,16 @@ components: properties: setting: $ref: '#/components/schemas/SettingsDto' + UserAssignRolesRequest: + required: + - roleIds + type: object + properties: + roleIds: + type: array + items: + type: integer + format: int32 UserAssignmentsDto: type: object properties: @@ -34619,22 +36010,13 @@ components: type: array items: $ref: '#/components/schemas/FolderRolesDto' - UserAssignRolesRequest: - required: - - roleIds - type: object - properties: - roleIds: - type: array - items: - type: integer - format: int32 UserChangeCultureRequest: required: - culture type: object properties: culture: + minLength: 1 type: string UserDto: type: object @@ -35044,6 +36426,7 @@ components: type: object properties: role: + minLength: 1 type: string toggle: type: boolean @@ -35073,12 +36456,42 @@ components: readOnly: true items: type: string + ErrorCodes: + type: array + readOnly: true + items: + type: string + enum: + - RobotNotAssignedToFolder + - RobotNotFound + - RobotNoCredentials + - RobotBusy + - RobotConcurrencyLimit + - TemplateNoRuntime + - TemplateNoHostsAvailable + - TemplateNoLicense + - TemplateFullCapacity + - TemplateNotAssignedToFolder + - TemplateMaintenanceMode + - DynamicJobAccountCredentialsInvalid + - DynamicJobForegroundAutomationTypeInvalid + - DynamicJobBackgroundAutomationTypeInvalid + - DynamicJobWindowsTargetFrameworkInvalid + - DynamicJobCrossPlatformTargetFrameworkInvalid + - DynamicJobConnectedMachinesInvalid + - DynamicJobConnectedMachinesUserCredentialsInvalid + - DynamicJobConnectedMachinesCrossPlatformRobotVersionInvalid + - DynamicJobConnectedMachinesWindowsRobotVersionInvalid + x-ms-enum: + name: JobPendingReasons + modelAsString: false VerifySmtpSettingRequest: required: - sendTo type: object properties: sendTo: + minLength: 1 type: string smtpSettingModel: $ref: '#/components/schemas/SmtpSettingModel' @@ -35095,6 +36508,16 @@ components: x-ms-enum: name: VideoRecordingSettingsDtoVideoRecordingType modelAsString: false + QueueItemVideoRecordingType: + type: string + default: None + enum: + - None + - Failed + - All + x-ms-enum: + name: VideoRecordingSettingsDtoQueueItemVideoRecordingType + modelAsString: false MaxDurationSeconds: type: integer format: int32 @@ -35102,6 +36525,7 @@ components: required: - AllowInsecureSsl - Enabled + - Name - SubscribeToAllEvents - Url type: object @@ -35139,19 +36563,6 @@ components: Id: type: integer format: int64 - WebhookEnvironmentDto: - type: object - properties: - Id: - type: integer - format: int64 - readOnly: true - Name: - type: string - readOnly: true - Description: - type: string - readOnly: true WebhookEventDto: required: - EventType @@ -35170,7 +36581,268 @@ components: Group: type: string description: Group - WebhookJobDto: + WebhookSimpleUserDto: + type: object + properties: + Id: + type: integer + format: int64 + readOnly: true + Key: + type: string + format: uuid + readOnly: true + UserName: + type: string + description: The name used to login to Orchestrator. + readOnly: true + Domain: + type: string + description: The domain from which the user is imported + readOnly: true + FullName: + type: string + description: The full name of the person constructed with the format Name Surname. + readOnly: true + EmailAddress: + type: string + description: The e-mail address associated with the user. + readOnly: true + Type: + type: string + description: The user type. + readOnly: true + enum: + - User + - Robot + - DirectoryUser + - DirectoryGroup + - DirectoryRobot + - DirectoryExternalApplication + x-ms-enum: + name: WebhookSimpleUserDtoType + modelAsString: false + IsActive: + type: boolean + description: States if the user is active or not. An inactive user cannot login to Orchestrator. + readOnly: true + LastLoginTime: + type: string + description: The date and time when the user last logged in, or null if the user never logged in. + format: date-time + readOnly: true + CreationTime: + type: string + description: The date and time when the user was created. + format: date-time + readOnly: true + AuthenticationSource: + type: string + description: The source which authenticated this user. + readOnly: true + WebhookTaskAssignmentChangedDto: + type: object + properties: + Title: + type: string + readOnly: true + Type: + type: string + readOnly: true + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: BaseWebhookTaskDtoType + modelAsString: false + Priority: + type: string + readOnly: true + enum: + - Low + - Medium + - High + - Critical + x-ms-enum: + name: BaseWebhookTaskDtoPriority + modelAsString: false + Status: + type: string + readOnly: true + enum: + - Unassigned + - Pending + - Completed + x-ms-enum: + name: BaseWebhookTaskDtoStatus + modelAsString: false + CreationTime: + type: string + format: date-time + readOnly: true + TaskCatalogName: + type: string + readOnly: true + Id: + type: integer + format: int64 + readOnly: true + OrganizationUnitId: + type: integer + format: int64 + readOnly: true + AssignedToUserId: + type: integer + format: int64 + readOnly: true + AssignedToUserIdOldValue: + type: integer + description: Id of the old user to whom the task was assigned + format: int64 + readOnly: true + description: This class defines DTO for Tasks Collection for webhook event Task.AssignmentChanged + WebhookTaskCompletedDto: + type: object + properties: + Title: + type: string + readOnly: true + Type: + type: string + readOnly: true + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: BaseWebhookTaskDtoType + modelAsString: false + Priority: + type: string + readOnly: true + enum: + - Low + - Medium + - High + - Critical + x-ms-enum: + name: BaseWebhookTaskDtoPriority + modelAsString: false + Status: + type: string + readOnly: true + enum: + - Unassigned + - Pending + - Completed + x-ms-enum: + name: BaseWebhookTaskDtoStatus + modelAsString: false + CreationTime: + type: string + format: date-time + readOnly: true + TaskCatalogName: + type: string + readOnly: true + Id: + type: integer + format: int64 + readOnly: true + OrganizationUnitId: + type: integer + format: int64 + readOnly: true + AssignedToUserId: + type: integer + format: int64 + readOnly: true + Action: + type: string + description: Action taken to complete the task + readOnly: true + description: This class defines DTO for Tasks Collection for webhook event Task.Completed + WebhookTaskCreatedDto: + type: object + properties: + Title: + type: string + readOnly: true + Type: + type: string + readOnly: true + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: BaseWebhookTaskDtoType + modelAsString: false + Priority: + type: string + readOnly: true + enum: + - Low + - Medium + - High + - Critical + x-ms-enum: + name: BaseWebhookTaskDtoPriority + modelAsString: false + Status: + type: string + readOnly: true + enum: + - Unassigned + - Pending + - Completed + x-ms-enum: + name: BaseWebhookTaskDtoStatus + modelAsString: false + CreationTime: + type: string + format: date-time + readOnly: true + TaskCatalogName: + type: string + readOnly: true + Id: + type: integer + format: int64 + readOnly: true + OrganizationUnitId: + type: integer + format: int64 + readOnly: true + AssignedToUserId: + type: integer + format: int64 + readOnly: true + description: This class defines DTO for Tasks Collection for webhook event Task.Created + WrappedEnvironmentDto: + type: object + properties: + Id: + type: integer + format: int64 + readOnly: true + Name: + type: string + readOnly: true + Description: + type: string + readOnly: true + WrappedJobDto: type: object properties: Id: @@ -35212,7 +36884,7 @@ components: - Suspended - Resumed x-ms-enum: - name: WebhookJobDtoState + name: WrappedJobDtoState modelAsString: false Source: type: string @@ -35232,8 +36904,9 @@ components: - StudioDesktop - AutomationOpsPipelines - Apps + - SAP x-ms-enum: - name: WebhookJobDtoSourceType + name: WrappedJobDtoSourceType modelAsString: false BatchExecutionKey: type: string @@ -35262,16 +36935,16 @@ components: - Attended - ServerlessGeneric x-ms-enum: - name: WebhookJobDtoType + name: WrappedJobDtoType modelAsString: false HostMachineName: type: string description: The name of the machine where the Robot run the job. readOnly: true Robot: - $ref: '#/components/schemas/WebhookRobotDto' + $ref: '#/components/schemas/WrappedRobotDto' Release: - $ref: '#/components/schemas/WebhookReleaseDto' + $ref: '#/components/schemas/WrappedReleaseDto' InputArguments: type: object properties: {} @@ -35306,7 +36979,7 @@ components: - AutomationCloudTestAutomation - AttendedStudioWeb x-ms-enum: - name: WebhookJobDtoRuntimeType + name: WrappedJobDtoRuntimeType modelAsString: false ProcessType: type: string @@ -35317,44 +36990,14 @@ components: - Process - TestAutomationProcess x-ms-enum: - name: WebhookJobDtoProcessType + name: WrappedJobDtoProcessType modelAsString: false SpecificPriorityValue: type: integer description: The priority for a job format: int32 readOnly: true - WebhookProcessingExceptionDto: - type: object - properties: - Reason: - type: string - description: The reason the processing failed. - readOnly: true - Details: - type: string - description: Stores additional details about the exception. - readOnly: true - Type: - type: string - description: The processing exception type, if any. - readOnly: true - enum: - - ApplicationException - - BusinessException - x-ms-enum: - name: WebhookProcessingExceptionDtoType - modelAsString: false - Timestamp: - type: string - description: The creation time - format: date-time - readOnly: true - AssociatedImageFilePath: - type: string - description: A path on the robot running computer to an image file that stores relevant information about the exception - e.g. a system print screen. - readOnly: true - WebhookProcessScheduleDto: + WrappedProcessScheduleDto: type: object properties: Id: @@ -35392,7 +37035,7 @@ components: - JobsCount - ModernJobsCount x-ms-enum: - name: WebhookProcessScheduleDtoStartStrategy + name: WrappedProcessScheduleDtoStartStrategy modelAsString: false StopStrategy: type: string @@ -35402,7 +37045,7 @@ components: - SoftStop - Kill x-ms-enum: - name: WebhookProcessScheduleDtoStopStrategy + name: WrappedProcessScheduleDtoStopStrategy modelAsString: false ExternalJobKey: type: string @@ -35444,7 +37087,37 @@ components: properties: {} description: Input parameters that will be passed to each job created by this schedule. readOnly: true - WebhookReleaseDto: + WrappedProcessingExceptionDto: + type: object + properties: + Reason: + type: string + description: The reason the processing failed. + readOnly: true + Details: + type: string + description: Stores additional details about the exception. + readOnly: true + Type: + type: string + description: The processing exception type, if any. + readOnly: true + enum: + - ApplicationException + - BusinessException + x-ms-enum: + name: WrappedProcessingExceptionDtoType + modelAsString: false + Timestamp: + type: string + description: The creation time + format: date-time + readOnly: true + AssociatedImageFilePath: + type: string + description: A path on the robot running computer to an image file that stores relevant information about the exception - e.g. a system print screen. + readOnly: true + WrappedReleaseDto: type: object properties: Id: @@ -35474,12 +37147,12 @@ components: format: int64 readOnly: true Environment: - $ref: '#/components/schemas/WebhookEnvironmentDto' + $ref: '#/components/schemas/WrappedEnvironmentDto' InputArguments: type: object properties: {} readOnly: true - WebhookRobotDto: + WrappedRobotDto: type: object properties: Id: @@ -35533,7 +37206,7 @@ components: - AutomationCloudTestAutomation - AttendedStudioWeb x-ms-enum: - name: WebhookRobotDtoType + name: WrappedRobotDtoType modelAsString: false HostingType: type: string @@ -35542,110 +37215,19 @@ components: - Standard - Floating x-ms-enum: - name: WebhookRobotDtoHostingType + name: WrappedRobotDtoHostingType modelAsString: false Environments: type: array readOnly: true items: - $ref: '#/components/schemas/WebhookEnvironmentDto' + $ref: '#/components/schemas/WrappedEnvironmentDto' ExecutionSettings: type: object additionalProperties: type: object readOnly: true - WebhookSimpleMachineDto: - type: object - properties: - Id: - type: integer - format: int64 - Key: - type: string - format: uuid - Name: - type: string - ServiceUserName: - type: string - Type: - type: string - enum: - - Standard - - Template - x-ms-enum: - name: WebhookSimpleMachineDtoType - modelAsString: false - Scope: - type: string - enum: - - Default - - Shared - - PersonalWorkspace - - Cloud - - Serverless - x-ms-enum: - name: WebhookSimpleMachineDtoScope - modelAsString: false - WebhookSimpleUserDto: - type: object - properties: - Id: - type: integer - format: int64 - readOnly: true - Key: - type: string - format: uuid - readOnly: true - UserName: - type: string - description: The name used to login to Orchestrator. - readOnly: true - Domain: - type: string - description: The domain from which the user is imported - readOnly: true - FullName: - type: string - description: The full name of the person constructed with the format Name Surname. - readOnly: true - EmailAddress: - type: string - description: The e-mail address associated with the user. - readOnly: true - Type: - type: string - description: The user type. - readOnly: true - enum: - - User - - Robot - - DirectoryUser - - DirectoryGroup - - DirectoryRobot - - DirectoryExternalApplication - x-ms-enum: - name: WebhookSimpleUserDtoType - modelAsString: false - IsActive: - type: boolean - description: States if the user is active or not. An inactive user cannot login to Orchestrator. - readOnly: true - LastLoginTime: - type: string - description: The date and time when the user last logged in, or null if the user never logged in. - format: date-time - readOnly: true - CreationTime: - type: string - description: The date and time when the user was created. - format: date-time - readOnly: true - AuthenticationSource: - type: string - description: The source which authenticated this user. - readOnly: true - WebhookStartProcessDto: + WrappedStartProcessDto: type: object properties: ReleaseKey: @@ -35664,7 +37246,7 @@ components: - JobsCount - ModernJobsCount x-ms-enum: - name: WebhookStartProcessDtoStrategy + name: WrappedStartProcessDtoStrategy modelAsString: false RobotIds: type: array @@ -35691,196 +37273,11 @@ components: - StudioDesktop - AutomationOpsPipelines - Apps + - SAP x-ms-enum: - name: WebhookStartProcessDtoSource - modelAsString: false - WebhookTaskAssignmentChangedDto: - type: object - properties: - Title: - type: string - readOnly: true - Type: - type: string - readOnly: true - enum: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - x-ms-enum: - name: BaseWebhookTaskDtoType - modelAsString: false - Priority: - type: string - readOnly: true - enum: - - Low - - Medium - - High - - Critical - x-ms-enum: - name: BaseWebhookTaskDtoPriority - modelAsString: false - Status: - type: string - readOnly: true - enum: - - Unassigned - - Pending - - Completed - x-ms-enum: - name: BaseWebhookTaskDtoStatus - modelAsString: false - CreationTime: - type: string - format: date-time - readOnly: true - TaskCatalogName: - type: string - readOnly: true - Id: - type: integer - format: int64 - readOnly: true - OrganizationUnitId: - type: integer - format: int64 - readOnly: true - AssignedToUserId: - type: integer - format: int64 - readOnly: true - AssignedToUserIdOldValue: - type: integer - description: Id of the old user to whom the task was assigned - format: int64 - readOnly: true - description: This class defines DTO for Tasks Collection for webhook event Task.AssignmentChanged - WebhookTaskCompletedDto: - type: object - properties: - Title: - type: string - readOnly: true - Type: - type: string - readOnly: true - enum: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - x-ms-enum: - name: BaseWebhookTaskDtoType - modelAsString: false - Priority: - type: string - readOnly: true - enum: - - Low - - Medium - - High - - Critical - x-ms-enum: - name: BaseWebhookTaskDtoPriority + name: WrappedStartProcessDtoSource modelAsString: false - Status: - type: string - readOnly: true - enum: - - Unassigned - - Pending - - Completed - x-ms-enum: - name: BaseWebhookTaskDtoStatus - modelAsString: false - CreationTime: - type: string - format: date-time - readOnly: true - TaskCatalogName: - type: string - readOnly: true - Id: - type: integer - format: int64 - readOnly: true - OrganizationUnitId: - type: integer - format: int64 - readOnly: true - AssignedToUserId: - type: integer - format: int64 - readOnly: true - Action: - type: string - description: Action taken to complete the task - readOnly: true - description: This class defines DTO for Tasks Collection for webhook event Task.Completed - WebhookTaskCreatedDto: - type: object - properties: - Title: - type: string - readOnly: true - Type: - type: string - readOnly: true - enum: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - x-ms-enum: - name: BaseWebhookTaskDtoType - modelAsString: false - Priority: - type: string - readOnly: true - enum: - - Low - - Medium - - High - - Critical - x-ms-enum: - name: BaseWebhookTaskDtoPriority - modelAsString: false - Status: - type: string - readOnly: true - enum: - - Unassigned - - Pending - - Completed - x-ms-enum: - name: BaseWebhookTaskDtoStatus - modelAsString: false - CreationTime: - type: string - format: date-time - readOnly: true - TaskCatalogName: - type: string - readOnly: true - Id: - type: integer - format: int64 - readOnly: true - OrganizationUnitId: - type: integer - format: int64 - readOnly: true - AssignedToUserId: - type: integer - format: int64 - readOnly: true - description: This class defines DTO for Tasks Collection for webhook event Task.Created - WebhookTaskDeletedDto: + WrappedTaskDeletedDto: type: object properties: Title: @@ -35895,6 +37292,7 @@ components: - DocumentValidationTask - DocumentClassificationTask - DataLabelingTask + - AppTask x-ms-enum: name: BaseWebhookTaskDtoType modelAsString: false @@ -35953,7 +37351,7 @@ components: format: date-time readOnly: true description: This class defines DTO for Tasks Collection for webhook event Task.Deleted - WebhookTaskForwardedDto: + WrappedTaskForwardedDto: type: object properties: Title: @@ -35968,6 +37366,7 @@ components: - DocumentValidationTask - DocumentClassificationTask - DataLabelingTask + - AppTask x-ms-enum: name: BaseWebhookTaskDtoType modelAsString: false @@ -36017,7 +37416,7 @@ components: format: int64 readOnly: true description: This class defines DTO for Tasks Collection for webhook event Task.Forwarded - WebhookTaskSavedDto: + WrappedTaskSavedDto: type: object properties: Title: @@ -36032,6 +37431,7 @@ components: - DocumentValidationTask - DocumentClassificationTask - DataLabelingTask + - AppTask x-ms-enum: name: BaseWebhookTaskDtoType modelAsString: false