{
  "opencollection": "1.0.0",
  "info": {
    "name": "Digital Assistant Service Instance Oda API",
    "version": "20190506"
  },
  "items": [
    {
      "info": {
        "name": "oda",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Compartment's Digital Assistant Instances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/odaInstances",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "List the Digital Assistant instances that belong to this compartment."
              },
              {
                "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": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "List only the Digital Assistant instances that are in this lifecycle state."
              },
              {
                "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 Digital Assistant instances that belong to the specified\ncompartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n"
        },
        {
          "info": {
            "name": "Create Digital Assistant Instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20190506/odaInstances",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "oci-splat-generated-ocids",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Starts an asynchronous job to create 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 Digital Assistant Instance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/odaInstances/:odaInstanceId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              }
            ]
          },
          "docs": "Gets the specified Digital Assistant instance."
        },
        {
          "info": {
            "name": "Update Digital Assistant Instance",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/20190506/odaInstances/:odaInstanceId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "oci-splat-generated-ocids",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified Digital Assistant instance with the information in the request body."
        },
        {
          "info": {
            "name": "Delete Digital Assistant Instance",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/20190506/odaInstances/:odaInstanceId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "oci-splat-generated-ocids",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              },
              {
                "name": "retentionTime",
                "value": "",
                "type": "query",
                "description": "Retain the ODA instance being deleted for the given number of days before hard-delete/purge."
              }
            ]
          },
          "docs": "Starts an asynchronous job to delete the specified Digital Assistant instance.\nTo monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`."
        },
        {
          "info": {
            "name": "Moves an Digital Assistant instance into a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20190506/odaInstances/:odaInstanceId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against\nETag values of the resource.\n"
        },
        {
          "info": {
            "name": "Starts an inactive Digital Assistant instance.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20190506/odaInstances/:odaInstanceId/actions/start",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              }
            ]
          },
          "docs": "Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering\nof requests will be started again.\n"
        },
        {
          "info": {
            "name": "Stops an active Digital Assistant instance.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20190506/odaInstances/:odaInstanceId/actions/stop",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              }
            ]
          },
          "docs": "Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering\nof requests will be stopped until the instance is started again. Data associated with the instance\nis not affected.\n"
        },
        {
          "info": {
            "name": "Gets a list of all attachments to an ODA instance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/odaInstances/:odaInstanceId/attachments",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              },
              {
                "name": "includeOwnerMetadata",
                "value": "",
                "type": "query",
                "description": "Whether to send attachment owner info during get/list call."
              },
              {
                "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": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "List only the ODA instance attachments that are in this lifecycle state."
              },
              {
                "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`.\nThe default sort order for `TIMECREATED` is descending.\n"
              }
            ]
          },
          "docs": "Returns a list of ODA instance attachments\n"
        },
        {
          "info": {
            "name": "Create Digital Assistant Instance Attachment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20190506/odaInstances/:odaInstanceId/attachments",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Starts an asynchronous job to create a Digital Assistant instance attachment.\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 ODA instance attachment information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/odaInstances/:odaInstanceId/attachments/:attachmentId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance attachment identifier."
              },
              {
                "name": "includeOwnerMetadata",
                "value": "",
                "type": "query",
                "description": "Whether to send attachment owner info during get/list call."
              }
            ]
          },
          "docs": "Gets an ODA instance attachment by identifier"
        },
        {
          "info": {
            "name": "Update the ODA instance attachment identified by the ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/20190506/odaInstances/:odaInstanceId/attachments/:attachmentId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance attachment identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the ODA instance attachment"
        },
        {
          "info": {
            "name": "Delete a Digital Assistant instance attachment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/20190506/odaInstances/:odaInstanceId/attachments/:attachmentId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance identifier."
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path",
                "description": "Unique Digital Assistant instance attachment identifier."
              }
            ]
          },
          "docs": "Starts an asynchronous job to delete the specified Digital Assistant instance attachment."
        },
        {
          "info": {
            "name": "List Compartment's Work Requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/workRequests",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "List the Digital Assistant instances that belong to this compartment."
              },
              {
                "name": "odaInstanceId",
                "value": "",
                "type": "query",
                "description": "List only the information for this Digital Assistant instance."
              },
              {
                "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": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return per page."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIME_ACCEPTED`.\n\nThe default sort order for the time fields is descending. The default order for `DISPLAYNAME` and `STATUS` is ascending.default: TIME_ACCEPTED\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)."
              }
            ]
          },
          "docs": "Returns a page of work requests for the specified compartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n"
        },
        {
          "info": {
            "name": "Get Work Request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/workRequests/:workRequestId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The identifier of the asynchronous work request."
              }
            ]
          },
          "docs": "Gets information about the work request with the specified ID, including its status.\n\nYou can use this operation to monitor the status of jobs that you\nrequested to create, delete, and update instances.\n"
        },
        {
          "info": {
            "name": "List Work Request Errors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/workRequests/:workRequestId/errors",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The identifier of the asynchronous work request."
              },
              {
                "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": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return per page."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `CODE` is ascending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)."
              }
            ]
          },
          "docs": "Returns a page of errors for the specified work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n"
        },
        {
          "info": {
            "name": "List Work Request Log Messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20190506/workRequests/:workRequestId/logs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The identifier of the asynchronous work request."
              },
              {
                "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": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return per page."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `MESSAGE` is ascending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)."
              }
            ]
          },
          "docs": "Returns a page of of log messages for a given work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n"
        }
      ]
    }
  ],
  "bundled": true
}