{
"opencollection": "1.0.0",
"info": {
"name": "Language AI Service Language API",
"version": "20221001"
},
"items": [
{
"info": {
"name": "AIServiceLanguage",
"type": "folder"
},
"items": [
{
"info": {
"name": "Batch detect dominant language over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchDetectDominantLanguage",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The API returns the detected language and a related confidence score (between 0 and 1). It supports passing a batch of records.\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n"
},
{
"info": {
"name": "Batch detect health entities over pre-deployed model",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchDetectHealthEntities",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The API extracts health entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records.\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n"
},
{
"info": {
"name": "Batch detect entities over pre-deployed model",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchDetectLanguageEntities",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The API extracts entities in text records. For each entity, its type/subtype and confidence score (between 0 and 1) is returned. It supports passing a batch of records.\n\n[List of supported entities.](/iaas/language/using/ner.htm#ner__sup-ner-entity)\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n"
},
{
"info": {
"name": "Batch detect keyPhrase over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchDetectLanguageKeyPhrases",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text. It supports passing a batch of records.\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n"
},
{
"info": {
"name": "Batch detect pii and phi entities over pre-deployed model",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchDetectLanguagePiiEntities",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The API extracts pii and phi entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records.\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n"
},
{
"info": {
"name": "Batch detect sentiments over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchDetectLanguageSentiments",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "level",
"value": "",
"type": "query",
"description": "Set this parameter for sentence and aspect level sentiment analysis.\nAllowed values are:\n - ASPECT\n - SENTENCE\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The API extracts aspect-based and sentence level sentiment in text records.\nThe text provided must have aspects for the model to detect otherwise the response is a blank array.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned for each record. Similarly, for sentence-level sentiment analysis, the sentiment is returned at the sentence level.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral "
},
{
"info": {
"name": "Batch detect text classification over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchDetectLanguageTextClassification",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nIt supports passing a batch of records.\n\nLearn more about text classification [here](/iaas/language/using/text-class.htm).\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n"
},
{
"info": {
"name": "Batch translation for translate text to other language over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/batchLanguageTranslation",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Translates a batch of text documents from source to target language.\nA batch can contain:\n - up to 100 records.\n - documents length less than 5000 characters.\n - 20,000 characters in total as a sum of all documents length.\n"
},
{
"info": {
"name": "Detect dominant language over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/detectDominantLanguage",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "We don't recommend using this API as deprecation is planned instead use the BatchDetectDominantLanguage API.\nThis API will be retired on Monday, 10 Oct 2023 00:00:00 GMT\nThe API returns the detected language and a related confidence score (between 0 and 1).\n\n[List of supported languages.](/iaas/language/using/pretrain-models.htm#lang-detect)\n\nLimitations:\n- A record may be up to 1000 characters long.\n"
},
{
"info": {
"name": "Detect entities over pre-deployed model",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/detectLanguageEntities",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelVersion",
"value": "",
"type": "query",
"description": "Named Entity Recognition model versions. By default user will get output from V2.1 implementation."
},
{
"name": "isPii",
"value": "",
"type": "query",
"description": "If this parameter is set to true, you only get PII (Personally identifiable information) entities\nlike PhoneNumber, Email, Person, and so on. Default value is false.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "We don't recommend using this API as deprecation is planned instead use the BatchDetectLanguageEntities API.\nThis API will be retired on Monday, 10 Oct 2023 00:00:00 GMT\nThe API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.\n\nLimitations:\n- A text may be up to 1000 characters long.\n"
},
{
"info": {
"name": "Detect keyPhrase over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/detectLanguageKeyPhrases",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "We don't recommend using this API as deprecation is planned instead use the BatchDetectLanguageKeyPhrases API.\nThis API will be retired on Monday, 10 Oct 2023 00:00:00 GMT\nThe API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text.\n\nLimitations:\n- A record may be up to 1000 characters long.\n"
},
{
"info": {
"name": "Detect sentiments over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/detectLanguageSentiments",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "We don't recommend using this API as deprecation is planned instead use the BatchDetectLanguageSentiments API.\nThis API will be retired on Monday, 10 Oct 2023 00:00:00 GMT\nThe API extracts aspect-based in text records.\nThe text provided must have aspects for the model to detect otherwise the response is a blank array.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.\n\nFor sentiment analysis, confidence scores are provided for each of the classes ("
},
{
"info": {
"name": "Detect text classification over pre-deployed model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/actions/detectLanguageTextClassification",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "We don't recommend using this API as deprecation is planned instead use the BatchDetectLanguageTextClassification API.\nThis API will be retired on Monday, 10 Oct 2023 00:00:00 GMT\nThe API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nLearn more about text classification [here](/iaas/language/using/pretrain-models.htm#text-class).\n\nLimitations:\n- A record may be up to 1000 characters long.\n"
},
{
"info": {
"name": "Gets a list of all Endpoints in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/endpoints",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "The ID of the compartment in which to list resources."
},
{
"name": "endpointId",
"value": "",
"type": "query",
"description": "The OCID of the endpoint."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "The ID of the project for which to list the objects."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "A filter to return only resources that match the entire display name given."
},
{
"name": "modelId",
"value": "",
"type": "query",
"description": "The ID of the trained model for which to list the endpoints."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order to use, either 'asc' or 'desc'."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Returns a list of Endpoints.\n"
},
{
"info": {
"name": "Creates a new Endpoint and deploy the trained model",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/endpoints",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new endpoint and deploy the trained model\n"
},
{
"info": {
"name": "Get an Endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/endpoints/:endpointId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "endpointId",
"value": "",
"type": "path",
"description": "The OCID of the endpoint."
}
]
},
"docs": "Gets an endpoint by identifier"
},
{
"info": {
"name": "Updates the endpoint",
"type": "http"
},
"http": {
"method": "PUT",
"url": "http://127.0.0.1/20221001/endpoints/:endpointId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "endpointId",
"value": "",
"type": "path",
"description": "The OCID of the endpoint."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the Endpoint identified by the id"
},
{
"info": {
"name": "Delete a provisioned Endpoint",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://127.0.0.1/20221001/endpoints/:endpointId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "endpointId",
"value": "",
"type": "path",
"description": "The OCID of the endpoint."
}
]
},
"docs": "Deletes a provisioned endpoint resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a model."
},
{
"info": {
"name": "Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/endpoints/:endpointId/actions/changeCompartment",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "endpointId",
"value": "",
"type": "path",
"description": "The OCID of the endpoint."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Gets a list of all language service async jobs in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/jobs",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "The ID of the compartment in which to list resources."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return only resources whose lifecycleState matches the given lifecycleState."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "A filter to return only resources that match the entire display name given."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Unique identifier(OCID)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order to use, either 'asc' or 'desc'."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
}
]
},
"docs": "Returns a list of language service async Jobs.\n"
},
{
"info": {
"name": "Creates a new language service async job",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/jobs",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new language service async job.\n"
},
{
"info": {
"name": "Gets a language service async job",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/jobs/:jobId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "Unique Transcription Job identifier."
}
]
},
"docs": "Gets a language service async job"
},
{
"info": {
"name": "Update language service async Job identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "http://127.0.0.1/20221001/jobs/:jobId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "Unique Transcription Job identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the language service async Job"
},
{
"info": {
"name": "Delete language service async Job identified by the id",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://127.0.0.1/20221001/jobs/:jobId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "Unique Transcription Job identifier."
}
]
},
"docs": "Deletes the language service async Job"
},
{
"info": {
"name": "Canceling the job cancels all the tasks under it.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/jobs/:jobId/actions/cancel",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "Unique Transcription Job identifier."
}
]
},
"docs": "Canceling the job cancels all the tasks under it."
},
{
"info": {
"name": "Moves a Job into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/jobs/:jobId/actions/changeCompartment",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "unique job OCID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a Job into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Retrieves model information like versions and capabilities",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/modelTypes/:modelType",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelType",
"value": "",
"type": "path",
"description": "Allowed values are :\nNAMED_ENTITY_RECOGNITION\nTEXT_CLASSIFICATION\nPRE_TRAINED_NAMED_ENTITY_RECOGNITION\nPRE_TRAINED_TEXT_CLASSIFICATION\nPRE_TRAINED_SENTIMENT_ANALYSIS\nPRE_TRAINED_KEYPHRASE_EXTRACTION\nPRE_TRAINED_LANGUAGE_DETECTION\nPRE_TRAINED_PII\n"
}
]
},
"docs": "Gets model capabilities and results like version and model supported info by specifying model type."
},
{
"info": {
"name": "Gets a list of all models in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/models",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "The ID of the compartment in which to list resources."
},
{
"name": "modelId",
"value": "",
"type": "query",
"description": "unique model OCID."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "The ID of the project for which to list the objects."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "A filter to return only resources that match the entire display name given."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order to use, either 'asc' or 'desc'."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Returns a list of models.\n"
},
{
"info": {
"name": "Creates a new Model for training and train the model with date provided.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/models",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new model for training and train the model with date provided.\n"
},
{
"info": {
"name": "Get a Model",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/models/:modelId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "unique model OCID."
}
]
},
"docs": "Gets a model by identifier"
},
{
"info": {
"name": "Update the Model identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "http://127.0.0.1/20221001/models/:modelId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "unique model OCID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the model"
},
{
"info": {
"name": "Delete a provisioned model",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://127.0.0.1/20221001/models/:modelId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "unique model OCID."
}
]
},
"docs": "Deletes a provisioned model resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a model."
},
{
"info": {
"name": "Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/models/:modelId/actions/changeCompartment",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "unique model OCID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Retrieves evaluation results for given model",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/models/:modelId/evaluationResults",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "unique model OCID."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
}
]
},
"docs": "Get a (paginated) list of evaluation results for a given model."
},
{
"info": {
"name": "Gets a list of all Projects in a compartment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/projects",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "The ID of the compartment in which to list resources."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "A filter to return only resources that match the entire display name given."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "The ID of the project for which to list the objects."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order to use, either 'asc' or 'desc'."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Returns a list of Projects.\n"
},
{
"info": {
"name": "Creates a new Project in the compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/projects",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Project.\n"
},
{
"info": {
"name": "Get Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/projects/:projectId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The OCID of the project."
}
]
},
"docs": "Gets a Project by identifier"
},
{
"info": {
"name": "Update the Project identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "http://127.0.0.1/20221001/projects/:projectId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The OCID of the project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the Project"
},
{
"info": {
"name": "Delete a provisioned Project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://127.0.0.1/20221001/projects/:projectId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The OCID of the project."
}
]
},
"docs": "Deletes a Project resource by identifier. This operation fails with a 409 error unless all associated resources (models deployments or data assets) are in a DELETED state. You must delete all associated resources before deleting a project."
},
{
"info": {
"name": "Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://127.0.0.1/20221001/projects/:projectId/actions/changeCompartment",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The OCID of the project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "List Work Requests",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/workRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "The ID of the compartment in which to list resources."
},
{
"name": "workRequestId",
"value": "",
"type": "query",
"description": "The ID of the asynchronous work request."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "resourceId",
"value": "",
"type": "query",
"description": "The ID of the resource for which list workrequests."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order to use, either 'asc' or 'desc'."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\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/20221001/workRequests/:workRequestId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The ID of the asynchronous request."
}
]
},
"docs": "Gets the status of the work request with the given ID."
},
{
"info": {
"name": "Lists work request errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/workRequests/:workRequestId/errors",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The ID of the asynchronous request."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order to use, either 'asc' or 'desc'."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
}
]
},
"docs": "Return a (paginated) list of errors for a given work request.\n"
},
{
"info": {
"name": "Lists work request logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://127.0.0.1/20221001/workRequests/:workRequestId/logs",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The ID of the asynchronous request."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order to use, either 'asc' or 'desc'."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
}
]
},
"docs": "Return a (paginated) list of logs for a given work request.\n"
}
]
}
],
"bundled": true
}