{ "opencollection": "1.0.0", "info": { "name": "Digital Assistant Service Instance Odapackage API", "version": "20190506" }, "items": [ { "info": { "name": "odapackage", "type": "folder" }, "items": [ { "info": { "name": "List packages that have been imported into the given instance.", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/importedPackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "name", "value": "", "type": "query", "description": "List only the information for the package with this name. Package names are unique to a publisher and may not change.\n\nExample: `My Package`\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results.\n\nYou get this value from the `opc-next-page` header in a previous list request.\nTo retireve the first page, omit this query parameter.\n\nExample: `MToxMA==`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.\n\nThe default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.\n" } ] }, "docs": "Returns a list of summaries for imported packages in the instance.\n" }, { "info": { "name": "Import Package into Digital Assistant Instance", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/importedPackages", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts an asynchronous job to import a package into a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n" }, { "info": { "name": "Get details for a package that has been imported into the given instance.", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/importedPackages/:packageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "packageId", "value": "", "type": "path", "description": "Unique Digital Assistant package identifier." } ] }, "docs": "Returns a list of summaries for imported packages in the instance.\n" }, { "info": { "name": "Update Package that has been imported into a Digital Assistant Instance", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/importedPackages/:packageId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "packageId", "value": "", "type": "path", "description": "Unique Digital Assistant package identifier." }, { "name": "isReplaceSkills", "value": "", "type": "query", "description": "Should old skills be replaced by new skills if packageId differs from already imported package?" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts an asynchronous job to update a package within a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n" }, { "info": { "name": "Delete Package from Digital Assistant Instance", "type": "http" }, "http": { "method": "DELETE", "url": "/20190506/odaInstances/:odaInstanceId/importedPackages/:packageId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "packageId", "value": "", "type": "path", "description": "Unique Digital Assistant package identifier." } ] }, "docs": "Starts an asynchronous job to delete a package from a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n" }, { "info": { "name": "Get details for a given package", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/packages/:packageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "packageId", "value": "", "type": "path", "description": "Unique Digital Assistant package identifier." } ] }, "docs": "Returns details about a package, and how to import it.\n" }, { "info": { "name": "List packages available for import", "type": "http" }, "http": { "method": "GET", "url": "/20190506/packages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "query", "description": "List only the information for this Digital Assistant instance." }, { "name": "resourceType", "value": "", "type": "query", "description": "Resource type identifier. Used to limit query results to the items which are applicable to the given type." }, { "name": "compartmentId", "value": "", "type": "query", "description": "List the packages that belong to this compartment." }, { "name": "name", "value": "", "type": "query", "description": "List only the information for the package with this name. Package names are unique to a publisher and may not change.\n\nExample: `My Package`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change.\n\nExample: `My new resource`\n" }, { "name": "isLatestVersionOnly", "value": "", "type": "query", "description": "Should we return only the latest version of a package (instead of all versions)?" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results.\n\nYou get this value from the `opc-next-page` header in a previous list request.\nTo retireve the first page, omit this query parameter.\n\nExample: `MToxMA==`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.\n\nThe default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.\n" } ] }, "docs": "Returns a page of summaries for packages that are available for import. The optional odaInstanceId query\nparameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId\nquery parameter is not provided, the returned list will\ninclude packages available within the region indicated by the request URL. The optional resourceType query\nparam may be specified to filter packages that contain the indicated resource type. If no resourceType query\nparam is gi" } ] } ], "bundled": true }