{ "opencollection": "1.0.0", "info": { "name": "Generative AI Agents Management Generative AI Agent API", "version": "20240531" }, "items": [ { "info": { "name": "generativeAiAgent", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of endpoints.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/agentEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "agentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of endpoints.\n" }, { "info": { "name": "Creates an endpoint.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/agentEndpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an endpoint.\n" }, { "info": { "name": "Get AgentEndpoint", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ] }, "docs": "Gets information about an endpoint.\n" }, { "info": { "name": "Updates an AgentEndpoint.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an endpoint.\n" }, { "info": { "name": "Deletes an AgentEndpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ] }, "docs": "Deletes an endpoint.\n" }, { "info": { "name": "Moves an AgentEndpoint into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Gets a list of Agents.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/agents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of agents.\n" }, { "info": { "name": "Creates an Agent.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/agents", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an agent.\n" }, { "info": { "name": "Get Agent", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/agents/:agentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent." } ] }, "docs": "Gets information about an agent.\n" }, { "info": { "name": "Updates an Agent.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240531/agents/:agentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an agent.\n" }, { "info": { "name": "Deletes an Agent.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/agents/:agentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent." } ] }, "docs": "Deletes an agent.\n" }, { "info": { "name": "Moves an agent into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/agents/:agentId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an agent into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Gets a list of data ingestion jobs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/dataIngestionJobs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "dataSourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of data ingestion jobs.\n" }, { "info": { "name": "Creates a data ingestion job.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/dataIngestionJobs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a data ingestion job.\n" }, { "info": { "name": "Get DataIngestionJob", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/dataIngestionJobs/:dataIngestionJobId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataIngestionJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job." } ] }, "docs": "Gets information about a data ingestion job.\n" }, { "info": { "name": "Deletes a data ingestion job.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/dataIngestionJobs/:dataIngestionJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataIngestionJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job." } ] }, "docs": "Deletes a data ingestion job.\n" }, { "info": { "name": "Gets the raw logs for a Data Ingestion job.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/dataIngestionJobs/:dataIngestionJobId/logs/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataIngestionJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job." } ] }, "docs": "Returns the raw log file for the specified data ingestion job in text format.\n" }, { "info": { "name": "Gets a list of data sources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/dataSources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "knowledgeBaseId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of data sources.\n" }, { "info": { "name": "Creates a DataSource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/dataSources", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a data source.\n" }, { "info": { "name": "Get DataSource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/dataSources/:dataSourceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source." } ] }, "docs": "Gets information about a data source.\n" }, { "info": { "name": "Updates a data source.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240531/dataSources/:dataSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a data source.\n" }, { "info": { "name": "Deletes a DataSource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/dataSources/:dataSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source." } ] }, "docs": "Deletes a data source.\n" }, { "info": { "name": "Gets a list of knowledge bases.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/knowledgeBases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of knowledge bases.\n" }, { "info": { "name": "Creates a KnowledgeBase.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/knowledgeBases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a knowledge base.\n" }, { "info": { "name": "Get KnowledgeBase", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/knowledgeBases/:knowledgeBaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base." } ] }, "docs": "Gets information about a knowledge base.\n" }, { "info": { "name": "Updates a knowledge base.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240531/knowledgeBases/:knowledgeBaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a knowledge base.\n" }, { "info": { "name": "Deletes a KnowledgeBase.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/knowledgeBases/:knowledgeBaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base." } ] }, "docs": "Deletes a knowledge base.\n" }, { "info": { "name": "Moves a KnowledgeBase into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/knowledgeBases/:knowledgeBaseId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a knowledge base into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Gets a list of provisioned capacities.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/provisionedCapacities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "provisionedCapacityId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of provisioned capacities.\n" }, { "info": { "name": "Creates a ProvisionedCapacity.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/provisionedCapacities", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a provisioned capacity.\n" }, { "info": { "name": "Get ProvisionedCapacity", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/provisionedCapacities/:provisionedCapacityId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "provisionedCapacityId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity." } ] }, "docs": "Gets information about a provisioned capacity.\n" }, { "info": { "name": "Updates a provisioned capacity.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240531/provisionedCapacities/:provisionedCapacityId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "provisionedCapacityId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a provisioned capacity.\n" }, { "info": { "name": "Deletes a ProvisionedCapacity.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/provisionedCapacities/:provisionedCapacityId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "provisionedCapacityId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity." } ] }, "docs": "Deletes a provisioned capacity.\n" }, { "info": { "name": "Moves a ProvisionedCapacity into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/provisionedCapacities/:provisionedCapacityId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "provisionedCapacityId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a provisioned capacity into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Gets a list of Tools.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/tools", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "agentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of tools.\n" }, { "info": { "name": "Creates a Tool.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/tools", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a tool.\n" }, { "info": { "name": "Get Tool", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/tools/:toolId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "toolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Tool." } ] }, "docs": "Gets information about a tool.\n" }, { "info": { "name": "Updates a Tool.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240531/tools/:toolId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "toolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Tool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a tool.\n" }, { "info": { "name": "Deletes a Tool.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/tools/:toolId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "toolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Tool." } ] }, "docs": "Deletes a tool.\n" }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the resources that match the given lifecycle state." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Gets the details of a work request.\n" }, { "info": { "name": "Cancel work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Cancels a work request.\n" }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the errors for a work request.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the logs for a work request.\n" } ] } ], "bundled": true }