components: schemas: AddObjectToProjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: projectScopeKeys: items: type: string type: array AssetUsage: properties: name: type: string type: type: string url: type: string AssignStructureDefaultWorkflowBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: workflow: type: string AssignToObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: className: type: string externalReferenceCode: type: string name: type: string BulkAction: discriminator: mapping: AddObjectToProjectBulkSelectionAction: "#/components/schemas/AddObjectToProjectBulkSelectionAction" AssignStructureDefaultWorkflowBulkSelectionAction: "#/components/schemas/AssignStructureDefaultWorkflowBulkSelectionAction" AssignToObjectBulkSelectionAction: "#/components/schemas/AssignToObjectBulkSelectionAction" CopyObjectBulkSelectionAction: "#/components/schemas/CopyObjectBulkSelectionAction" DefaultPermissionObjectBulkSelectionAction: "#/components/schemas/DefaultPermissionObjectBulkSelectionAction" DeleteObjectAssetVersionBulkSelectionAction: "#/components/schemas/DeleteObjectAssetVersionBulkSelectionAction" DeleteObjectBulkSelectionAction: "#/components/schemas/DeleteObjectBulkSelectionAction" DeleteObjectEntryBulkSelectionAction: "#/components/schemas/DeleteObjectEntryBulkSelectionAction" DueDateObjectBulkSelectionAction: "#/components/schemas/DueDateObjectBulkSelectionAction" DuplicateObjectBulkSelectionAction: "#/components/schemas/DuplicateObjectBulkSelectionAction" EditObjectCategoriesBulkSelectionAction: "#/components/schemas/EditObjectCategoriesBulkSelectionAction" EditObjectTagsBulkSelectionAction: "#/components/schemas/EditObjectTagsBulkSelectionAction" ExpireObjectBulkSelectionAction: "#/components/schemas/ExpireObjectBulkSelectionAction" MoveObjectBulkSelectionAction: "#/components/schemas/MoveObjectBulkSelectionAction" PermissionObjectBulkSelectionAction: "#/components/schemas/PermissionObjectBulkSelectionAction" ResetPermissionObjectBulkSelectionAction: "#/components/schemas/ResetPermissionObjectBulkSelectionAction" RestoreObjectBulkSelectionAction: "#/components/schemas/RestoreObjectBulkSelectionAction" StatusObjectBulkSelectionAction: "#/components/schemas/StatusObjectBulkSelectionAction" UpdateExpirationDateObjectBulkSelectionAction: "#/components/schemas/UpdateExpirationDateObjectBulkSelectionAction" UpdateObjectValuesBulkSelectionAction: "#/components/schemas/UpdateObjectValuesBulkSelectionAction" UpdateReviewDateObjectBulkSelectionAction: "#/components/schemas/UpdateReviewDateObjectBulkSelectionAction" propertyName: type properties: bulkActionItems: items: $ref: "#/components/schemas/BulkActionItem" type: array selectionScope: $ref: "#/components/schemas/SelectionScope" type: enum: - AddObjectToProjectBulkSelectionAction - AssignStructureDefaultWorkflowBulkSelectionAction - AssignToObjectBulkSelectionAction - CopyObjectBulkSelectionAction - DefaultPermissionObjectBulkSelectionAction - DeleteObjectAssetVersionBulkSelectionAction - DeleteObjectBulkSelectionAction - DeleteObjectEntryBulkSelectionAction - DueDateObjectBulkSelectionAction - DuplicateObjectBulkSelectionAction - ExpireObjectBulkSelectionAction - EditObjectTagsBulkSelectionAction - MoveObjectBulkSelectionAction - PermissionObjectBulkSelectionAction - ResetPermissionObjectBulkSelectionAction - RestoreObjectBulkSelectionAction - StatusObjectBulkSelectionAction - EditObjectCategoriesBulkSelectionAction - UpdateExpirationDateObjectBulkSelectionAction - UpdateObjectValuesBulkSelectionAction - UpdateReviewDateObjectBulkSelectionAction type: string BulkActionItem: properties: attributes: additionalProperties: type: object type: object classExternalReferenceCode: type: string className: type: string classPK: format: int64 type: integer name: type: string BulkActionTask: properties: actionName: type: string author: type: string completionDate: format: date-time type: string createdDate: format: date-time type: string executeStatus: type: string externalReferenceCode: type: string id: format: int64 type: integer numberOfItems: type: integer type: type: string CopyObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: objectEntryFolderId: description: The object entry folder's ID. format: int64 type: integer DefaultPermissionObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: defaultPermissions: type: string depotGroupId: format: int64 type: integer roleKey: type: string treePath: type: string DeleteObjectAssetVersionBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: className: type: string classPK: format: int64 type: integer versions: items: type: integer type: array DeleteObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: className: type: string DeleteObjectEntryBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" DocumentBulkSelection: properties: documentIds: items: type: string type: array selectionScope: $ref: "#/components/schemas/SelectionScope" DueDateObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: dueDate: format: date-time type: string DuplicateObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" EditObjectCategoriesBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: append: type: boolean taxonomyCategoryIdsToAdd: items: format: int64 type: integer type: array taxonomyCategoryIdsToRemove: items: format: int64 type: integer type: array EditObjectTagsBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: append: type: boolean keywordsToAdd: items: type: string type: array keywordsToRemove: items: type: string type: array ExpireObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" GenericError: description: https://www.schema.org/GenericError properties: message: type: string type: object Keyword: properties: name: type: string KeywordBulkSelection: allOf: - $ref: "#/components/schemas/DocumentBulkSelection" x-merge-properties: false - properties: keywordsToAdd: items: type: string type: array keywordsToRemove: items: type: string type: array MoveObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: objectEntryFolderId: description: The object entry folder's ID. format: int64 type: integer PermissionObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: configuration: type: string permissions: items: type: permission type: array roleKey: type: string ResetPermissionObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" RestoreObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" Selection: properties: size: format: int64 type: integer SelectionScope: properties: folderId: format: int64 type: integer repositoryId: format: int64 type: integer selectAll: type: boolean type: object Status: properties: actionInProgress: type: boolean type: object StatusObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: status: type: string TaxonomyCategory: properties: taxonomyCategoryId: format: int64 type: integer taxonomyCategoryName: type: string TaxonomyCategoryBulkSelection: allOf: - $ref: "#/components/schemas/DocumentBulkSelection" x-merge-properties: false - properties: taxonomyCategoryIdsToAdd: items: format: int64 type: integer type: array taxonomyCategoryIdsToRemove: items: format: int64 type: integer type: array TaxonomyVocabulary: properties: multiValued: type: boolean name: type: string required: type: boolean taxonomyCategories: items: $ref: "#/components/schemas/TaxonomyCategory" type: array taxonomyVocabularyId: format: int64 type: integer UpdateExpirationDateObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: expirationDate: format: date-time type: string UpdateObjectValuesBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: values: additionalProperties: type: object type: object UpdateReviewDateObjectBulkSelectionAction: allOf: - $ref: "#/components/schemas/BulkAction" - properties: reviewDate: format: date-time type: string info: description: "A Java client JAR is available for use with the group ID 'com.liferay', artifact ID 'com.liferay.bulk.rest.client', and version '3.0.45'." license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html title: "" version: v1.0 openapi: 3.0.1 paths: "/bulk-action": post: description: Execute a bulk action operationId: postBulkAction parameters: - in: query name: blueprintExternalReferenceCode schema: type: string - in: query name: emptySearch schema: type: boolean - in: query description: Model class names to be searched for. Defaults to all. name: entryClassNames schema: type: string - in: query description: The list of fields to be returned. name: fields schema: type: string - in: query name: filter schema: type: string - in: query name: nestedFields schema: type: string - in: query name: page schema: type: integer - in: query name: pageSize schema: type: integer - in: query name: restrictFields schema: type: string - in: query name: scope schema: type: string - in: query name: search schema: type: string - in: query name: sort schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/BulkAction" application/xml: schema: $ref: "#/components/schemas/BulkAction" responses: 200: content: application/json: schema: $ref: "#/components/schemas/BulkActionTask" application/xml: schema: $ref: "#/components/schemas/BulkActionTask" tags: ["BulkAction"] "/bulk-action-item/preview": post: description: Creates a preview for each item based on the bulk action type operationId: postBulkActionItemPreviewPage parameters: - in: query name: fetchChildren schema: type: boolean - in: query name: filter schema: type: string - in: query name: page required: true schema: type: integer - in: query name: pageSize required: true schema: type: integer - in: query name: search schema: type: string - in: query name: sort schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/BulkAction" application/xml: schema: $ref: "#/components/schemas/BulkAction" responses: 200: content: application/json: schema: items: $ref: "#/components/schemas/BulkActionItem" type: array application/xml: schema: items: $ref: "#/components/schemas/BulkActionItem" type: array tags: ["BulkAction"] "/bulk-selection": post: operationId: postBulkSelection requestBody: content: application/json: schema: $ref: "#/components/schemas/DocumentBulkSelection" application/xml: schema: $ref: "#/components/schemas/DocumentBulkSelection" responses: 200: content: application/json: schema: $ref: "#/components/schemas/Selection" application/xml: schema: $ref: "#/components/schemas/Selection" tags: ["Selection"] "/keywords/batch": patch: requestBody: content: application/json: schema: $ref: "#/components/schemas/KeywordBulkSelection" application/xml: schema: $ref: "#/components/schemas/KeywordBulkSelection" responses: 204: content: application/json: {} application/xml: {} tags: ["Keyword"] put: requestBody: content: application/json: schema: $ref: "#/components/schemas/KeywordBulkSelection" application/xml: schema: $ref: "#/components/schemas/KeywordBulkSelection" responses: 204: content: application/json: {} application/xml: {} tags: ["Keyword"] "/keywords/common": post: operationId: postKeywordsCommonPage parameters: - in: query name: blueprintExternalReferenceCode schema: type: string - in: query name: emptySearch schema: type: boolean - in: query description: Model class names to be searched for. Defaults to all. name: entryClassNames schema: type: string - in: query description: The list of fields to be returned. name: fields schema: type: string - in: query name: filter schema: type: string - in: query name: nestedFields schema: type: string - in: query name: restrictFields schema: type: string - in: query name: scope schema: type: string - in: query name: search schema: type: string - in: query name: sort schema: type: string requestBody: content: application/json: schema: oneOf: - $ref: "#/components/schemas/BulkAction" - $ref: "#/components/schemas/DocumentBulkSelection" application/xml: schema: oneOf: - $ref: "#/components/schemas/BulkAction" - $ref: "#/components/schemas/DocumentBulkSelection" responses: 200: content: application/json: schema: items: $ref: "#/components/schemas/Keyword" type: array application/xml: schema: items: $ref: "#/components/schemas/Keyword" type: array tags: ["Keyword"] "/sites/{siteId}/taxonomy-vocabularies/common": post: operationId: postSiteTaxonomyVocabulariesCommonPage parameters: - in: path name: siteId required: true schema: format: int64 type: integer - in: query name: blueprintExternalReferenceCode schema: type: string - in: query name: emptySearch schema: type: boolean - in: query description: Model class names to be searched for. Defaults to all. name: entryClassNames schema: type: string - in: query description: The list of fields to be returned. name: fields schema: type: string - in: query name: filter schema: type: string - in: query name: nestedFields schema: type: string - in: query name: restrictFields schema: type: string - in: query name: scope schema: type: string - in: query name: search schema: type: string - in: query name: sort schema: type: string requestBody: content: application/json: schema: oneOf: - $ref: "#/components/schemas/BulkAction" - $ref: "#/components/schemas/DocumentBulkSelection" application/xml: schema: oneOf: - $ref: "#/components/schemas/BulkAction" - $ref: "#/components/schemas/DocumentBulkSelection" responses: 200: content: application/json: schema: items: $ref: "#/components/schemas/TaxonomyVocabulary" type: array application/xml: schema: items: $ref: "#/components/schemas/TaxonomyVocabulary" type: array tags: ["TaxonomyVocabulary"] "/status": get: operationId: getStatus responses: 200: content: application/json: schema: $ref: "#/components/schemas/Status" application/xml: schema: $ref: "#/components/schemas/Status" tags: ["Status"] "/taxonomy-categories/batch": patch: requestBody: content: application/json: schema: $ref: "#/components/schemas/TaxonomyCategoryBulkSelection" application/xml: schema: $ref: "#/components/schemas/TaxonomyCategoryBulkSelection" responses: 204: content: application/json: {} application/xml: {} tags: ["TaxonomyCategory"] put: requestBody: content: application/json: schema: $ref: "#/components/schemas/TaxonomyCategoryBulkSelection" application/xml: schema: $ref: "#/components/schemas/TaxonomyCategoryBulkSelection" responses: 200: content: application/json: {} application/xml: {} tags: ["TaxonomyCategory"]