|
2 | 2 | "swagger": "2.0", |
3 | 3 | "info": { |
4 | 4 | "title": "OPERA Cloud Activity API", |
5 | | - "description": "APIs to cater for Sales Activity functionality in OPERA Cloud. <br /><br /> Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.<br /><br /> Compatible with OPERA Cloud release 24.1.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>", |
6 | | - "version": "24.1", |
| 5 | + "description": "APIs to cater for Sales Activity functionality in OPERA Cloud. <br /><br /> Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.<br /><br /> Compatible with OPERA Cloud release 24.2.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>", |
| 6 | + "version": "24.2", |
7 | 7 | "termsOfService": "https://www.oracle.com/legal/terms.html", |
8 | 8 | "contact": { |
9 | 9 | |
|
551 | 551 | "tags": [ |
552 | 552 | "Activity" |
553 | 553 | ] |
| 554 | + }, |
| 555 | + "put": { |
| 556 | + "summary": "Operation to update multiple activities", |
| 557 | + "description": "You can use this API to bulk update activities <p><strong>OperationId:</strong>putBulkActivities</p>", |
| 558 | + "operationId": "putBulkActivities", |
| 559 | + "parameters": [ |
| 560 | + { |
| 561 | + "name": "putBulkActivities", |
| 562 | + "in": "body", |
| 563 | + "required": true, |
| 564 | + "description": "Request object that will Change a list of activities.", |
| 565 | + "schema": { |
| 566 | + "allOf": [ |
| 567 | + { |
| 568 | + "$ref": "#/definitions/activitiesBulkUpdate" |
| 569 | + } |
| 570 | + ] |
| 571 | + } |
| 572 | + }, |
| 573 | + { |
| 574 | + "$ref": "#/parameters/authKey" |
| 575 | + }, |
| 576 | + { |
| 577 | + "$ref": "#/parameters/x-app-key" |
| 578 | + }, |
| 579 | + { |
| 580 | + "$ref": "#/parameters/x-hotelid" |
| 581 | + }, |
| 582 | + { |
| 583 | + "$ref": "#/parameters/x-externalsystem" |
| 584 | + }, |
| 585 | + { |
| 586 | + "$ref": "#/parameters/Accept-Language" |
| 587 | + } |
| 588 | + ], |
| 589 | + "responses": { |
| 590 | + "200": { |
| 591 | + "headers": { |
| 592 | + "Content-Language": { |
| 593 | + "type": "string", |
| 594 | + "description": "Audience language", |
| 595 | + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", |
| 596 | + "x-example": "en-GB" |
| 597 | + }, |
| 598 | + "Location": { |
| 599 | + "type": "string", |
| 600 | + "description": "Location of newly created resource" |
| 601 | + } |
| 602 | + }, |
| 603 | + "description": "Status/Info of the processed activities.", |
| 604 | + "schema": { |
| 605 | + "$ref": "#/definitions/activitiesBulkUpdateStatus" |
| 606 | + } |
| 607 | + }, |
| 608 | + "400": { |
| 609 | + "$ref": "#/responses/400" |
| 610 | + }, |
| 611 | + "401": { |
| 612 | + "$ref": "#/responses/401" |
| 613 | + }, |
| 614 | + "403": { |
| 615 | + "$ref": "#/responses/403" |
| 616 | + }, |
| 617 | + "404": { |
| 618 | + "$ref": "#/responses/404" |
| 619 | + }, |
| 620 | + "405": { |
| 621 | + "$ref": "#/responses/405" |
| 622 | + }, |
| 623 | + "406": { |
| 624 | + "$ref": "#/responses/406" |
| 625 | + }, |
| 626 | + "413": { |
| 627 | + "$ref": "#/responses/413" |
| 628 | + }, |
| 629 | + "414": { |
| 630 | + "$ref": "#/responses/414" |
| 631 | + }, |
| 632 | + "415": { |
| 633 | + "$ref": "#/responses/415" |
| 634 | + }, |
| 635 | + "500": { |
| 636 | + "$ref": "#/responses/500" |
| 637 | + }, |
| 638 | + "502": { |
| 639 | + "$ref": "#/responses/502" |
| 640 | + }, |
| 641 | + "503": { |
| 642 | + "$ref": "#/responses/503" |
| 643 | + } |
| 644 | + }, |
| 645 | + "consumes": [ |
| 646 | + "application/json;charset=UTF-8" |
| 647 | + ], |
| 648 | + "produces": [ |
| 649 | + "application/json;charset=UTF-8" |
| 650 | + ], |
| 651 | + "tags": [ |
| 652 | + "Activity" |
| 653 | + ] |
554 | 654 | } |
555 | 655 | }, |
556 | 656 | "/activities/activitiesCompletion": { |
|
6130 | 6230 | "items": { |
6131 | 6231 | "$ref": "#/definitions/activityId" |
6132 | 6232 | } |
| 6233 | + }, |
| 6234 | + "activitiesBulkUpdate": { |
| 6235 | + "type": "object", |
| 6236 | + "description": "Request object that will Change a list of activities.", |
| 6237 | + "properties": { |
| 6238 | + "activitiesBulkUpdate": { |
| 6239 | + "description": "Activities information, that is going to be updated in batch.", |
| 6240 | + "$ref": "#/definitions/activitiesBulkUpdateType" |
| 6241 | + }, |
| 6242 | + "links": { |
| 6243 | + "$ref": "#/definitions/links" |
| 6244 | + }, |
| 6245 | + "warnings": { |
| 6246 | + "$ref": "#/definitions/warningsType" |
| 6247 | + } |
| 6248 | + } |
| 6249 | + }, |
| 6250 | + "activitiesBulkUpdateType": { |
| 6251 | + "type": "object", |
| 6252 | + "description": "Collection of Activity Ids their details to be updated.", |
| 6253 | + "properties": { |
| 6254 | + "activityIdList": { |
| 6255 | + "type": "array", |
| 6256 | + "description": "Selected activities Unique identifier.", |
| 6257 | + "maxItems": 200, |
| 6258 | + "items": { |
| 6259 | + "$ref": "#/definitions/activityIdRecord" |
| 6260 | + } |
| 6261 | + }, |
| 6262 | + "skipProcessing": { |
| 6263 | + "description": "Boolean flag if True will skip processing activities", |
| 6264 | + "type": "boolean" |
| 6265 | + }, |
| 6266 | + "activityRec": { |
| 6267 | + "description": "Selected activities to be updated with these activity details.", |
| 6268 | + "$ref": "#/definitions/activityChanges" |
| 6269 | + } |
| 6270 | + } |
| 6271 | + }, |
| 6272 | + "activityChanges": { |
| 6273 | + "type": "object", |
| 6274 | + "description": "Activities details to be updated.", |
| 6275 | + "properties": { |
| 6276 | + "activityClass": { |
| 6277 | + "description": "Indicates the Activity Class.", |
| 6278 | + "$ref": "#/definitions/activityConfigClassType" |
| 6279 | + }, |
| 6280 | + "activityType": { |
| 6281 | + "description": "Indicates the Activity Type used for the Activity.", |
| 6282 | + "type": "string", |
| 6283 | + "minLength": 0, |
| 6284 | + "maxLength": 20 |
| 6285 | + }, |
| 6286 | + "activityPurpose": { |
| 6287 | + "description": "Indicates Purpose of the Activity.", |
| 6288 | + "type": "string", |
| 6289 | + "minLength": 0, |
| 6290 | + "maxLength": 100 |
| 6291 | + }, |
| 6292 | + "activityTraceCode": { |
| 6293 | + "description": "Activity Trace code used for the Activity.", |
| 6294 | + "type": "string", |
| 6295 | + "minLength": 0, |
| 6296 | + "maxLength": 20 |
| 6297 | + }, |
| 6298 | + "activityOwner": { |
| 6299 | + "description": "Owner of Activity.", |
| 6300 | + "type": "string", |
| 6301 | + "minLength": 0, |
| 6302 | + "maxLength": 20 |
| 6303 | + }, |
| 6304 | + "startDate": { |
| 6305 | + "description": "Start Date of Activity.", |
| 6306 | + "type": "string", |
| 6307 | + "format": "date" |
| 6308 | + }, |
| 6309 | + "startTime": { |
| 6310 | + "description": "Start time of the Activity.", |
| 6311 | + "type": "string" |
| 6312 | + }, |
| 6313 | + "endDate": { |
| 6314 | + "description": "End Date of Activity.", |
| 6315 | + "type": "string", |
| 6316 | + "format": "date" |
| 6317 | + }, |
| 6318 | + "endTime": { |
| 6319 | + "description": "End time of the Activity.", |
| 6320 | + "type": "string" |
| 6321 | + }, |
| 6322 | + "notes": { |
| 6323 | + "description": "Notes associated with an Activity.", |
| 6324 | + "type": "string", |
| 6325 | + "minLength": 0, |
| 6326 | + "maxLength": 4000 |
| 6327 | + }, |
| 6328 | + "highPriority": { |
| 6329 | + "description": "Indicates whether Activity has a high priority.", |
| 6330 | + "type": "boolean" |
| 6331 | + }, |
| 6332 | + "activityAccount": { |
| 6333 | + "description": "The list of accounts associated with an activity.", |
| 6334 | + "$ref": "#/definitions/uniqueID_Type" |
| 6335 | + }, |
| 6336 | + "activityContact": { |
| 6337 | + "description": "The list of accounts associated with an activity.", |
| 6338 | + "$ref": "#/definitions/uniqueID_Type" |
| 6339 | + } |
| 6340 | + } |
| 6341 | + }, |
| 6342 | + "activityIdRecord": { |
| 6343 | + "type": "object", |
| 6344 | + "description": "Unique identifier for the Activity Record containing activity ID and activity property.", |
| 6345 | + "properties": { |
| 6346 | + "hotelId": { |
| 6347 | + "description": "Hotel code to which activity belongs", |
| 6348 | + "type": "string", |
| 6349 | + "minLength": 0, |
| 6350 | + "maxLength": 20 |
| 6351 | + }, |
| 6352 | + "id": { |
| 6353 | + "description": "Unique ID belonging to the activity.", |
| 6354 | + "type": "string", |
| 6355 | + "minLength": 0, |
| 6356 | + "maxLength": 80 |
| 6357 | + } |
| 6358 | + } |
| 6359 | + }, |
| 6360 | + "activitiesBulkUpdateStatus": { |
| 6361 | + "type": "object", |
| 6362 | + "properties": { |
| 6363 | + "activitiesBulkUpdateStatusType": { |
| 6364 | + "description": "Status/Info of the processed activities.", |
| 6365 | + "type": "array", |
| 6366 | + "maxItems": 4000, |
| 6367 | + "items": { |
| 6368 | + "$ref": "#/definitions/activitiesProcessedInfoType" |
| 6369 | + } |
| 6370 | + } |
| 6371 | + } |
| 6372 | + }, |
| 6373 | + "activitiesProcessedInfoType": { |
| 6374 | + "type": "object", |
| 6375 | + "description": "Status/Info of the processed activities.", |
| 6376 | + "properties": { |
| 6377 | + "activityIdRecord": { |
| 6378 | + "description": "The activity details which were not processed.", |
| 6379 | + "$ref": "#/definitions/activityIdRecord" |
| 6380 | + }, |
| 6381 | + "reason": { |
| 6382 | + "description": "Reason for not processing the activity.", |
| 6383 | + "type": "string" |
| 6384 | + }, |
| 6385 | + "processingInfoType": { |
| 6386 | + "description": "Flag to indicate the warning messages from the API", |
| 6387 | + "type": "string" |
| 6388 | + }, |
| 6389 | + "processingInfoCode": { |
| 6390 | + "description": "Erorr/Warning code for not processing the activity.", |
| 6391 | + "type": "string", |
| 6392 | + "minLength": 0, |
| 6393 | + "maxLength": 200 |
| 6394 | + } |
| 6395 | + } |
6133 | 6396 | } |
6134 | 6397 | }, |
6135 | 6398 | "tags": [ |
|
0 commit comments