{ "opencollection": "1.0.0", "info": { "name": "Digital Assistant Service Instance Management API", "version": "20190506" }, "items": [ { "info": { "name": "management", "type": "folder" }, "items": [ { "info": { "name": "Configure the Digital Assistant Parameters for the Digital Assistant instance", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/actions/configureDigitalAssistantParameters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.\n" }, { "info": { "name": "Import Bot", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/actions/importBot", "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": "Import a Bot archive from Object Storage." }, { "info": { "name": "List Authentication Providers", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/authenticationProviders", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "id", "value": "", "type": "query", "description": "Unique Authentication Provider identifier." }, { "name": "identityProvider", "value": "", "type": "query", "description": "List only Authentication Providers for this Identity Provider." }, { "name": "name", "value": "", "type": "query", "description": "List only the information for Authentication Providers with this name. Authentication Provider names are unique and may not change.\n\nExample: `MyProvider`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "List only the resources 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` and `timeUpdated` is descending.\nFor all other sort fields the default sort order is ascending.\n" } ] }, "docs": "Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.\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 Authentication Provider", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/authenticationProviders", "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": "Creates a new Authentication Provider\n" }, { "info": { "name": "Get Authentication Provider", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/authenticationProviders/:authenticationProviderId", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "authenticationProviderId", "value": "", "type": "path", "description": "Unique Authentication Provider identifier." } ] }, "docs": "Gets the specified Authentication Provider." }, { "info": { "name": "Update Authentication Provider", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/authenticationProviders/:authenticationProviderId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "authenticationProviderId", "value": "", "type": "path", "description": "Unique Authentication Provider identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Authentication Provider with the information in the request body." }, { "info": { "name": "Delete Authentication Provider", "type": "http" }, "http": { "method": "DELETE", "url": "/20190506/odaInstances/:odaInstanceId/authenticationProviders/:authenticationProviderId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "authenticationProviderId", "value": "", "type": "path", "description": "Unique Authentication Provider identifier." } ] }, "docs": "Delete the specified Authentication Provider." }, { "info": { "name": "List Channels", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/channels", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "id", "value": "", "type": "query", "description": "Unique Channel identifier." }, { "name": "name", "value": "", "type": "query", "description": "List only the information for Channels with this name. Channels names are unique and may not change.\n\nExample: `MyChannel`\n" }, { "name": "category", "value": "", "type": "query", "description": "List only Channels with this category." }, { "name": "type", "value": "", "type": "query", "description": "List only Channels of this type." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "List only the resources 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` and `timeUpdated` is descending, and the default sort order for `name` is ascending.\n" } ] }, "docs": "Returns a page of Channels that belong to the specified Digital Assistant instance.\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 Channel", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/channels", "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": "Creates a new Channel.\n" }, { "info": { "name": "Get Channel", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/channels/:channelId", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "channelId", "value": "", "type": "path", "description": "Unique Channel identifier." } ] }, "docs": "Gets the specified Channel." }, { "info": { "name": "Update Channel", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/channels/:channelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "channelId", "value": "", "type": "path", "description": "Unique Channel identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Channel with the information in the request body." }, { "info": { "name": "Delete Channel", "type": "http" }, "http": { "method": "DELETE", "url": "/20190506/odaInstances/:odaInstanceId/channels/:channelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "channelId", "value": "", "type": "path", "description": "Unique Channel identifier." } ] }, "docs": "Delete the specified Channel." }, { "info": { "name": "Rotate generated keys for the Channel.", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/channels/:channelId/actions/rotateKeys", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "channelId", "value": "", "type": "path", "description": "Unique Channel identifier." } ] }, "docs": "This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken).\nIf a Channel has no generated keys then no changes will be made.\nEnsure that you take note of the newly generated keys in the response as they will not be returned again.\n" }, { "info": { "name": "Start a Channel.", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/channels/:channelId/actions/start", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "channelId", "value": "", "type": "path", "description": "Unique Channel identifier." } ] }, "docs": "Starts a Channel so that it will begin accepting messages.\n" }, { "info": { "name": "Stop a Channel.", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/channels/:channelId/actions/stop", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "channelId", "value": "", "type": "path", "description": "Unique Channel identifier." } ] }, "docs": "Stops a Channel so that it will no longer accept messages.\n" }, { "info": { "name": "List Digital Assistants", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "id", "value": "", "type": "query", "description": "Unique Digital Assistant identifier." }, { "name": "category", "value": "", "type": "query", "description": "List only Bot resources with this category." }, { "name": "name", "value": "", "type": "query", "description": "List only Bot resources with this name. Names are unique and may not change.\n\nExample: `MySkill`\n" }, { "name": "version", "value": "", "type": "query", "description": "List only Bot resources with this version. Versions are unique and may not change.\n\nExample: `1.0`\n" }, { "name": "namespace", "value": "", "type": "query", "description": "List only Bot resources with this namespace. Namespaces may not change.\n\nExample: `MyNamespace`\n" }, { "name": "platformVersion", "value": "", "type": "query", "description": "List only Bot resources with this platform version.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "List only the resources that are in this lifecycle state." }, { "name": "lifecycleDetails", "value": "", "type": "query", "description": "List only Bot resources with this lifecycle details.\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` and `timeUpdated` is descending.\nFor all other sort fields the default sort order is ascending.\n" } ] }, "docs": "Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.\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", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants", "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": "Creates a new Digital Assistant.\n" }, { "info": { "name": "Get Digital Assistant", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." } ] }, "docs": "Gets the specified Digital Assistant." }, { "info": { "name": "Update Digital Assistant", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Digital Assistant with the information in the request body." }, { "info": { "name": "Delete Digital Assistant", "type": "http" }, "http": { "method": "DELETE", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." } ] }, "docs": "Delete the specified Digital Assistant.\n" }, { "info": { "name": "Export a Digital Assistant to Object Storage", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId/actions/export", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports the specified Digital Assistant as an archive to Object Storage." }, { "info": { "name": "Publish Digital Assistant", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId/actions/publish", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." } ] }, "docs": "Publish a draft Digital Assistant.\nOnce published the Digital Assistant cannot be modified.\n" }, { "info": { "name": "List Digital Assistant Parameters", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId/parameters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." }, { "name": "name", "value": "", "type": "query", "description": "List only Parameters with this name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "List only the resources 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 `name`.\n\nThe default sort order is ascending.\n" } ] }, "docs": "Returns a page of Parameters that belong to the specified Digital Assistant.\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 Digital Assistant Parameter", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId/parameters/:parameterName", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." }, { "name": "parameterName", "value": "", "type": "path", "description": "The name of a Digital Assistant Parameter. This is unique with the Digital Assistant." } ] }, "docs": "Gets the specified Digital Assistant Parameter." }, { "info": { "name": "Update Digital Assistant Parameter", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/digitalAssistants/:digitalAssistantId/parameters/:parameterName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "digitalAssistantId", "value": "", "type": "path", "description": "Unique Digital Assistant identifier." }, { "name": "parameterName", "value": "", "type": "path", "description": "The name of a Digital Assistant Parameter. This is unique with the Digital Assistant." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Digital Assistant Parameter with the information in the request body." }, { "info": { "name": "List Skills", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/skills", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "id", "value": "", "type": "query", "description": "Unique Skill identifier." }, { "name": "category", "value": "", "type": "query", "description": "List only Bot resources with this category." }, { "name": "name", "value": "", "type": "query", "description": "List only Bot resources with this name. Names are unique and may not change.\n\nExample: `MySkill`\n" }, { "name": "version", "value": "", "type": "query", "description": "List only Bot resources with this version. Versions are unique and may not change.\n\nExample: `1.0`\n" }, { "name": "namespace", "value": "", "type": "query", "description": "List only Bot resources with this namespace. Namespaces may not change.\n\nExample: `MyNamespace`\n" }, { "name": "platformVersion", "value": "", "type": "query", "description": "List only Bot resources with this platform version.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "List only the resources that are in this lifecycle state." }, { "name": "lifecycleDetails", "value": "", "type": "query", "description": "List only Bot resources with this lifecycle details.\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` and `timeUpdated` is descending.\nFor all other sort fields the default sort order is ascending.\n" } ] }, "docs": "Returns a page of Skills that belong to the specified Digital Assistant instance.\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 Skill", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/skills", "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": "Creates a new Skill from scratch.\n" }, { "info": { "name": "Get Skill", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." } ] }, "docs": "Gets the specified Skill." }, { "info": { "name": "Update Skill", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Skill with the information in the request body." }, { "info": { "name": "Delete Skill", "type": "http" }, "http": { "method": "DELETE", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." } ] }, "docs": "Delete the specified Skill.\n" }, { "info": { "name": "Export a Skill to Object Storage", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId/actions/export", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports the specified Skill as an archive to Object Storage." }, { "info": { "name": "Publish Skill", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId/actions/publish", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." } ] }, "docs": "Publish a draft Skill.\nOnce published it cannot be modified.\n" }, { "info": { "name": "List Skill Parameters", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId/parameters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." }, { "name": "name", "value": "", "type": "query", "description": "List only Parameters with this name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "List only the resources 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 `name`.\n\nThe default sort order is ascending.\n" } ] }, "docs": "Returns a page of Skill Parameters that belong to the specified Skill.\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 Skill Parameter", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId/parameters", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Skill Parameter.\n" }, { "info": { "name": "Get Skill Parameter", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId/parameters/:parameterName", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." }, { "name": "parameterName", "value": "", "type": "path", "description": "The name of a Skill Parameter." } ] }, "docs": "Gets the specified Skill Parameter." }, { "info": { "name": "Update Skill Parameter", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId/parameters/:parameterName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." }, { "name": "parameterName", "value": "", "type": "path", "description": "The name of a Skill Parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Skill Parameter with the information in the request body." }, { "info": { "name": "Delete Skill Parameter", "type": "http" }, "http": { "method": "DELETE", "url": "/20190506/odaInstances/:odaInstanceId/skills/:skillId/parameters/:parameterName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "skillId", "value": "", "type": "path", "description": "Unique Skill identifier." }, { "name": "parameterName", "value": "", "type": "path", "description": "The name of a Skill Parameter." } ] }, "docs": "Delete the specified Skill Parameter.\n" }, { "info": { "name": "List Translators", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/translators", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "id", "value": "", "type": "query", "description": "Unique Translator identifier." }, { "name": "type", "value": "", "type": "query", "description": "List only Translators of this type." }, { "name": "name", "value": "", "type": "query", "description": "List only Translators with this name. Translator names are unique and may not change.\n\nExample: `MyTranslator`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "List only the resources 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` and `timeUpdated` is descending.\nFor all other sort fields the default sort order is ascending.\n" } ] }, "docs": "Returns a page of Translators that belong to the specified Digital Assistant instance.\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 Translator", "type": "http" }, "http": { "method": "POST", "url": "/20190506/odaInstances/:odaInstanceId/translators", "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": "Creates a new Translator\n" }, { "info": { "name": "Get Translator", "type": "http" }, "http": { "method": "GET", "url": "/20190506/odaInstances/:odaInstanceId/translators/:translatorId", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "translatorId", "value": "", "type": "path", "description": "Unique Translator identifier." } ] }, "docs": "Gets the specified Translator." }, { "info": { "name": "Update Translator", "type": "http" }, "http": { "method": "PUT", "url": "/20190506/odaInstances/:odaInstanceId/translators/:translatorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "translatorId", "value": "", "type": "path", "description": "Unique Translator identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Translator with the information in the request body." }, { "info": { "name": "Delete Translator", "type": "http" }, "http": { "method": "DELETE", "url": "/20190506/odaInstances/:odaInstanceId/translators/:translatorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "odaInstanceId", "value": "", "type": "path", "description": "Unique Digital Assistant instance identifier." }, { "name": "translatorId", "value": "", "type": "path", "description": "Unique Translator identifier." } ] }, "docs": "Delete the specified Translator." } ] } ], "bundled": true }